Skip to main content
PATCH
PATCH /v1/searchIndexes/{id}

Update a Search Index

Update a search index’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

string
required
UUID of the search index to update.

Update by Name

Use PATCH /v1/searchIndexes/name/{fqn} to update by fully qualified name.
string
required
Fully qualified name of the search index (e.g., elasticsearch_sample.table_search_index).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
string
Updated description in Markdown format.
string
Updated display name.
array
Updated list of owner references.
array
Updated classification tags.
string
Updated domain FQN.
object
Updated custom property values.
PATCH /v1/searchIndexes/{id}

Returns

Returns the updated search index object with the new version number.

Response

string
Unique identifier for the search index (UUID format).
string
Search index name.
string
Fully qualified name in format service.indexName.
string
Updated description.
number
Incremented version number.

Error Handling