POST /v1/searchIndexes

from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes
from metadata.generated.schema.api.data.createSearchIndex import CreateSearchIndexRequest

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

request = CreateSearchIndexRequest(
    name="table_search_index",
    displayName="TableSearchIndex",
    service="elasticsearch_sample",
    description="Search index for table entities",
    fields=[
        {"name": "name", "dataType": "TEXT"},
        {"name": "description", "dataType": "TEXT"}
    ]
)

search_index = SearchIndexes.create(request)
print(f"Created: {search_index.fullyQualifiedName.root}")

import java.util.List;
import org.openmetadata.schema.api.data.CreateSearchIndex;
import org.openmetadata.schema.entity.data.SearchIndex;
import org.openmetadata.schema.type.SearchIndexDataType;
import org.openmetadata.schema.type.SearchIndexField;
import org.openmetadata.sdk.fluent.SearchIndexes;

CreateSearchIndex request = new CreateSearchIndex()
    .withName("table_search_index")
    .withDisplayName("TableSearchIndex")
    .withService("elasticsearch_sample")
    .withDescription("Search index for table entities")
    .withFields(List.of(
        new SearchIndexField().withName("name").withDataType(SearchIndexDataType.TEXT),
        new SearchIndexField().withName("description").withDataType(SearchIndexDataType.TEXT)));

SearchIndex searchIndex = SearchIndexes.create(request);

curl -X POST "{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"}
    ]
  }'

{
  "id": "f5b0fa81-f241-4508-9219-dae31dcced18",
  "name": "table_search_index",
  "fullyQualifiedName": "elasticsearch_sample.table_search_index",
  "displayName": "TableSearchIndex",
  "version": 0.1,
  "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": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

POST

searchIndexes

POST /v1/searchIndexes

from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes
from metadata.generated.schema.api.data.createSearchIndex import CreateSearchIndexRequest

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

request = CreateSearchIndexRequest(
    name="table_search_index",
    displayName="TableSearchIndex",
    service="elasticsearch_sample",
    description="Search index for table entities",
    fields=[
        {"name": "name", "dataType": "TEXT"},
        {"name": "description", "dataType": "TEXT"}
    ]
)

search_index = SearchIndexes.create(request)
print(f"Created: {search_index.fullyQualifiedName.root}")

import java.util.List;
import org.openmetadata.schema.api.data.CreateSearchIndex;
import org.openmetadata.schema.entity.data.SearchIndex;
import org.openmetadata.schema.type.SearchIndexDataType;
import org.openmetadata.schema.type.SearchIndexField;
import org.openmetadata.sdk.fluent.SearchIndexes;

CreateSearchIndex request = new CreateSearchIndex()
    .withName("table_search_index")
    .withDisplayName("TableSearchIndex")
    .withService("elasticsearch_sample")
    .withDescription("Search index for table entities")
    .withFields(List.of(
        new SearchIndexField().withName("name").withDataType(SearchIndexDataType.TEXT),
        new SearchIndexField().withName("description").withDataType(SearchIndexDataType.TEXT)));

SearchIndex searchIndex = SearchIndexes.create(request);

curl -X POST "{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"}
    ]
  }'

{
  "id": "f5b0fa81-f241-4508-9219-dae31dcced18",
  "name": "table_search_index",
  "fullyQualifiedName": "elasticsearch_sample.table_search_index",
  "displayName": "TableSearchIndex",
  "version": 0.1,
  "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": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Create a Search Index

Create a new search index within a search service.

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

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, INT, 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.

POST /v1/searchIndexes

from metadata.sdk import configure
from metadata.sdk.entities import SearchIndexes
from metadata.generated.schema.api.data.createSearchIndex import CreateSearchIndexRequest

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

request = CreateSearchIndexRequest(
    name="table_search_index",
    displayName="TableSearchIndex",
    service="elasticsearch_sample",
    description="Search index for table entities",
    fields=[
        {"name": "name", "dataType": "TEXT"},
        {"name": "description", "dataType": "TEXT"}
    ]
)

search_index = SearchIndexes.create(request)
print(f"Created: {search_index.fullyQualifiedName.root}")

import java.util.List;
import org.openmetadata.schema.api.data.CreateSearchIndex;
import org.openmetadata.schema.entity.data.SearchIndex;
import org.openmetadata.schema.type.SearchIndexDataType;
import org.openmetadata.schema.type.SearchIndexField;
import org.openmetadata.sdk.fluent.SearchIndexes;

CreateSearchIndex request = new CreateSearchIndex()
    .withName("table_search_index")
    .withDisplayName("TableSearchIndex")
    .withService("elasticsearch_sample")
    .withDescription("Search index for table entities")
    .withFields(List.of(
        new SearchIndexField().withName("name").withDataType(SearchIndexDataType.TEXT),
        new SearchIndexField().withName("description").withDataType(SearchIndexDataType.TEXT)));

SearchIndex searchIndex = SearchIndexes.create(request);

curl -X POST "{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"}
    ]
  }'

{
  "id": "f5b0fa81-f241-4508-9219-dae31dcced18",
  "name": "table_search_index",
  "fullyQualifiedName": "elasticsearch_sample.table_search_index",
  "displayName": "TableSearchIndex",
  "version": 0.1,
  "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": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Returns

Returns the created search index object with all specified properties and system-generated fields.

Response

string

Unique identifier for the search index (UUID format).

string

Search index name.

string

Fully qualified name in format service.indexName.

string

Human-readable display name.

string

Description of the search index in Markdown format.

object

Reference to the parent search service.

Show properties

string

UUID of the search service.

string

Type of entity (always searchService).

string

Name of the search service.

string

Fully qualified name of the search service.

array

Array of field definitions for the index schema.

Show properties

string

Name of the field.

string

Data type of the field.

string

Description of the field.

array

Nested child fields.

string

Type of search service, for example ElasticSearch, OpenSearch.

array

List of owners assigned 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

Domain assignments for governance.

array

Classification tags applied to the search index.

Show properties

string

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.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/searchIndexes instead of POST to perform an upsert. If a search index with the same fullyQualifiedName already exists, it will be updated; otherwise, a new search index is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/searchIndexes" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead.

Bulk Create or Update (PUT)

Use PUT /v1/searchIndexes/bulk to create or update multiple search indexes in a single request. The request body is an array of create request objects.

curl -X PUT "{base_url}/api/v1/searchIndexes/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "index_one", "service": "elasticsearch_sample" },
    { "name": "index_two", "service": "elasticsearch_sample" }
  ]'

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create search indexes
`409`	`ENTITY_ALREADY_EXISTS`	Search index with same name already exists in service (POST only)

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Create a Search Index

Create a Search Index

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling