GET /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"
)

# Get by ID
si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18")
print(f"{si.fullyQualifiedName}: {si.description}")

# Get by ID with fields
si = SearchIndexes.retrieve(
    "f5b0fa81-f241-4508-9219-dae31dcced18",
    fields=["owners", "tags", "fields"]
)

# Get by fully qualified name
si = SearchIndexes.retrieve_by_name("elasticsearch_sample.table_search_index")

# Get by name with fields
si = SearchIndexes.retrieve_by_name(
    "elasticsearch_sample.table_search_index",
    fields=["owners", "tags", "domain"]
)

import static org.openmetadata.sdk.fluent.SearchIndexes.*;

// Get by ID
var si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18");

// Get by ID with fields
var si = SearchIndexes.retrieve(
    "f5b0fa81-f241-4508-9219-dae31dcced18",
    "owners,tags,fields"
);

// Get by fully qualified name
var si = SearchIndexes.retrieveByName(
    "elasticsearch_sample.table_search_index"
);

// Get by name with fields
var si = SearchIndexes.retrieveByName(
    "elasticsearch_sample.table_search_index",
    "owners,tags,domain"
);

# Get by ID
curl "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

searchIndexes

{id}

GET /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"
)

# Get by ID
si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18")
print(f"{si.fullyQualifiedName}: {si.description}")

# Get by ID with fields
si = SearchIndexes.retrieve(
    "f5b0fa81-f241-4508-9219-dae31dcced18",
    fields=["owners", "tags", "fields"]
)

# Get by fully qualified name
si = SearchIndexes.retrieve_by_name("elasticsearch_sample.table_search_index")

# Get by name with fields
si = SearchIndexes.retrieve_by_name(
    "elasticsearch_sample.table_search_index",
    fields=["owners", "tags", "domain"]
)

import static org.openmetadata.sdk.fluent.SearchIndexes.*;

// Get by ID
var si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18");

// Get by ID with fields
var si = SearchIndexes.retrieve(
    "f5b0fa81-f241-4508-9219-dae31dcced18",
    "owners,tags,fields"
);

// Get by fully qualified name
var si = SearchIndexes.retrieveByName(
    "elasticsearch_sample.table_search_index"
);

// Get by name with fields
var si = SearchIndexes.retrieveByName(
    "elasticsearch_sample.table_search_index",
    "owners,tags,domain"
);

# Get by ID
curl "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

Retrieve a Search Index

Get a single search index by its unique ID or fully qualified name.

Get by ID

string

required

UUID of the search index to retrieve.

string

Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,sourceHash).

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/searchIndexes/name/{fqn} to retrieve by fully qualified name.

string

required

Fully qualified name of the search index (e.g., elasticsearch_sample.table_search_index).

string

Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, sourceHash.

string

default:"non-deleted"

Include all, deleted, or non-deleted entities.

GET /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"
)

# Get by ID
si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18")
print(f"{si.fullyQualifiedName}: {si.description}")

# Get by ID with fields
si = SearchIndexes.retrieve(
    "f5b0fa81-f241-4508-9219-dae31dcced18",
    fields=["owners", "tags", "fields"]
)

# Get by fully qualified name
si = SearchIndexes.retrieve_by_name("elasticsearch_sample.table_search_index")

# Get by name with fields
si = SearchIndexes.retrieve_by_name(
    "elasticsearch_sample.table_search_index",
    fields=["owners", "tags", "domain"]
)

import static org.openmetadata.sdk.fluent.SearchIndexes.*;

// Get by ID
var si = SearchIndexes.retrieve("f5b0fa81-f241-4508-9219-dae31dcced18");

// Get by ID with fields
var si = SearchIndexes.retrieve(
    "f5b0fa81-f241-4508-9219-dae31dcced18",
    "owners,tags,fields"
);

// Get by fully qualified name
var si = SearchIndexes.retrieveByName(
    "elasticsearch_sample.table_search_index"
);

// Get by name with fields
var si = SearchIndexes.retrieveByName(
    "elasticsearch_sample.table_search_index",
    "owners,tags,domain"
);

# Get by ID
curl "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/searchIndexes/f5b0fa81-f241-4508-9219-dae31dcced18?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/searchIndexes/name/elasticsearch_sample.table_search_index?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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 a search index object with all requested fields populated.

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

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 (e.g., ElasticSearch, OpenSearch).

number

Version number for the entity.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this search index
`404`	`NOT_FOUND`	Search index with given ID or FQN does not exist

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Retrieve a Search Index

Retrieve a Search Index

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling

​Retrieve a Search Index

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Search Index

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling