Skip to main content
PATCH
https://sandbox.getcollate.io/api
/
v1
/
searchIndexes
/
{id}
PATCH /v1/searchIndexes/{id}
from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes

configure(
    host="https://your-company.getcollate.io/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}")

{
  "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

​
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.
​
fqn
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.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
owners
array
Updated list of owner references.
​
tags
array
Updated classification tags.
​
domain
string
Updated domain FQN.
​
extension
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.getcollate.io/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}")

{
  "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

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

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this search index
404NOT_FOUNDSearch index with given ID or FQN does not exist
409CONFLICTConcurrent modification detected