PUT /v1/searchIndexes

curl -X PUT "{base_url}/api/v1/searchIndexes" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "table_search_index",
    "displayName": "TableSearchIndex",
    "service": "elasticsearch_sample",
    "description": "Search index for table entities",
    "fields": [
      {"name": "name", "dataType": "TEXT"},
      {"name": "description", "dataType": "TEXT"}
    ]
  }'

from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18")
si.description = "Updated: Search index for table entities with enhanced mapping"
updated = SearchIndexes.update(si)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.SearchIndex;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
SearchIndex searchIndex = client.searchIndexes().get("f5b0fa81-f241-4508-9219-dae31dcced18");
searchIndex.setDescription("Updated: Search index for table entities with enhanced mapping");
SearchIndex updated = client.searchIndexes().update(searchIndex.getId(), searchIndex);

# Update by ID
curl -X PATCH "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated search index for table entities"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated search index for table entities"}
  ]'

{
  "id": "f5b0fa81-f241-4508-9219-dae31dcced18",
  "name": "table_search_index",
  "fullyQualifiedName": "elasticsearch_sample.table_search_index",
  "displayName": "TableSearchIndex",
  "description": "Updated search index for table entities",
  "version": 0.2,
  "updatedAt": 1769982670810,
  "updatedBy": "admin",
  "service": {
    "id": "search-service-id",
    "type": "searchService",
    "name": "elasticsearch_sample",
    "fullyQualifiedName": "elasticsearch_sample",
    "deleted": false
  },
  "serviceType": "ElasticSearch",
  "fields": [
    {"name": "name", "dataType": "TEXT"},
    {"name": "description", "dataType": "TEXT"}
  ],
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

PUT

searchIndexes

PUT /v1/searchIndexes

curl -X PUT "{base_url}/api/v1/searchIndexes" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "table_search_index",
    "displayName": "TableSearchIndex",
    "service": "elasticsearch_sample",
    "description": "Search index for table entities",
    "fields": [
      {"name": "name", "dataType": "TEXT"},
      {"name": "description", "dataType": "TEXT"}
    ]
  }'

from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18")
si.description = "Updated: Search index for table entities with enhanced mapping"
updated = SearchIndexes.update(si)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.SearchIndex;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
SearchIndex searchIndex = client.searchIndexes().get("f5b0fa81-f241-4508-9219-dae31dcced18");
searchIndex.setDescription("Updated: Search index for table entities with enhanced mapping");
SearchIndex updated = client.searchIndexes().update(searchIndex.getId(), searchIndex);

# Update by ID
curl -X PATCH "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated search index for table entities"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated search index for table entities"}
  ]'

{
  "id": "f5b0fa81-f241-4508-9219-dae31dcced18",
  "name": "table_search_index",
  "fullyQualifiedName": "elasticsearch_sample.table_search_index",
  "displayName": "TableSearchIndex",
  "description": "Updated search index for table entities",
  "version": 0.2,
  "updatedAt": 1769982670810,
  "updatedBy": "admin",
  "service": {
    "id": "search-service-id",
    "type": "searchService",
    "name": "elasticsearch_sample",
    "fullyQualifiedName": "elasticsearch_sample",
    "deleted": false
  },
  "serviceType": "ElasticSearch",
  "fields": [
    {"name": "name", "dataType": "TEXT"},
    {"name": "description", "dataType": "TEXT"}
  ],
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Update a Search Index

Create a search index or update it if it already exists, using PUT /v1/searchIndexes with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the search index. Must be unique within the parent search service.

string

required

Fully qualified name of the parent SearchService, for example elasticsearch_sample.

array

required

Array of field objects defining the index schema.

Show properties

string

Name of the field.

string

Data type of the field, for example TEXT, KEYWORD, INTEGER, OBJECT.

string

Description of the field.

array

Nested child fields for complex types.

string

Human-readable display name for the search index.

string

Description of the search index in Markdown format.

array

Array of owner references (users or teams) to assign to the search index.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Fully qualified names of the domains to assign for governance purposes.

array

Array of classification tags to apply to the search index.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

object

Custom property values defined by your organization’s metadata schema.

PUT /v1/searchIndexes

curl -X PUT "{base_url}/api/v1/searchIndexes" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "table_search_index",
    "displayName": "TableSearchIndex",
    "service": "elasticsearch_sample",
    "description": "Search index for table entities",
    "fields": [
      {"name": "name", "dataType": "TEXT"},
      {"name": "description", "dataType": "TEXT"}
    ]
  }'

from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18")
si.description = "Updated: Search index for table entities with enhanced mapping"
updated = SearchIndexes.update(si)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.SearchIndex;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
SearchIndex searchIndex = client.searchIndexes().get("f5b0fa81-f241-4508-9219-dae31dcced18");
searchIndex.setDescription("Updated: Search index for table entities with enhanced mapping");
SearchIndex updated = client.searchIndexes().update(searchIndex.getId(), searchIndex);

# Update by ID
curl -X PATCH "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated search index for table entities"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated search index for table entities"}
  ]'

{
  "id": "f5b0fa81-f241-4508-9219-dae31dcced18",
  "name": "table_search_index",
  "fullyQualifiedName": "elasticsearch_sample.table_search_index",
  "displayName": "TableSearchIndex",
  "description": "Updated search index for table entities",
  "version": 0.2,
  "updatedAt": 1769982670810,
  "updatedBy": "admin",
  "service": {
    "id": "search-service-id",
    "type": "searchService",
    "name": "elasticsearch_sample",
    "fullyQualifiedName": "elasticsearch_sample",
    "deleted": false
  },
  "serviceType": "ElasticSearch",
  "fields": [
    {"name": "name", "dataType": "TEXT"},
    {"name": "description", "dataType": "TEXT"}
  ],
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

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

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this search index
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Search Index

Update a Search Index

Body Parameters

Returns

Response

Error Handling