Search Indexes

A Search Index is a data structure within a Search Service that enables efficient full-text and structured search over metadata entities.

Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Search Indexes belong to a Search Service:

SearchService
└── SearchIndex (this page)

The FQN format for a search index is:

service.indexName

For example: elasticsearch_sample.table_search_index

Method	Endpoint	Description
`PUT`	`/v1/searchIndexes`	Create or update a search index
`POST`	`/v1/searchIndexes`	Create a search index (POST variant)
`GET`	`/v1/searchIndexes`	List search indexes
`GET`	`/v1/searchIndexes/{id}`	Get by ID
`GET`	`/v1/searchIndexes/name/{fqn}`	Get by FQN
`PATCH`	`/v1/searchIndexes/{id}`	Update by ID
`PATCH`	`/v1/searchIndexes/name/{fqn}`	Update by name
`DELETE`	`/v1/searchIndexes/{id}`	Delete by ID
`DELETE`	`/v1/searchIndexes/name/{fqn}`	Delete by name
`PUT`	`/v1/searchIndexes/restore`	Restore soft-deleted search index
`GET`	`/v1/searchIndexes/{id}/versions`	List versions
`GET`	`/v1/searchIndexes/{id}/versions/{version}`	Get specific version
`PUT`	`/v1/searchIndexes/{id}/followers`	Add follower
`DELETE`	`/v1/searchIndexes/{id}/followers/{userId}`	Remove follower
`PUT`	`/v1/searchIndexes/{id}/vote`	Add/update vote

⌘I