PATCH /v1/searchIndexes/{id}
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}")
import static org.openmetadata.sdk.fluent.SearchIndexes.*;
// Retrieve, modify, and update
var si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18");
si.setDescription("Updated: Search index for table entities with enhanced mapping");
var updated = SearchIndexes.update(si);
# 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
Update search index properties using JSON Patch
PATCH
/
v1
/
searchIndexes
/
{id}
PATCH /v1/searchIndexes/{id}
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}")
import static org.openmetadata.sdk.fluent.SearchIndexes.*;
// Retrieve, modify, and update
var si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18");
si.setDescription("Updated: Search index for table entities with enhanced mapping");
var updated = SearchIndexes.update(si);
# 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
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
UsePATCH /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
array
string
Updated domain FQN.
object
Updated custom property values.
PATCH /v1/searchIndexes/{id}
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}")
import static org.openmetadata.sdk.fluent.SearchIndexes.*;
// Retrieve, modify, and update
var si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18");
si.setDescription("Updated: Search index for table entities with enhanced mapping");
var updated = SearchIndexes.update(si);
# 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 JSON patch or malformed request |
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to update this search index |
404 | NOT_FOUND | Search index with given ID or FQN does not exist |
409 | CONFLICT | Concurrent modification detected |
Was this page helpful?