List Search Indexes

List all search indexes with optional filtering and pagination

GET /v1/searchIndexes

GET /v1/searchIndexes

Python

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

# List first page
indexes = SearchIndexes.list(limit=50)
for si in indexes.data:
    print(f"{si.fullyQualifiedName}")

# List all with auto-pagination
for si in SearchIndexes.list_all():
    print(f"{si.fullyQualifiedName}")

# Filter by service
indexes = SearchIndexes.list(
    service="elasticsearch_sample",
    fields=["owners", "tags", "domain"],
    limit=50
)

for si in indexes.data:
    print(f"{si.fullyQualifiedName}")
    if si.owners:
        print(f"  Owners: {[o.name for o in si.owners]}")
    if si.tags:
        print(f"  Tags: {[t.tagFQN for t in si.tags]}")

Response

{
  "data": [
    {
      "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": [],
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

List Search Indexes

List all search indexes with optional filtering and pagination.

Query Parameters

service · string

Filter by search service fully qualified name.

limit · integer · default: "10"

Maximum number of results to return (max: 1000000).

before · string

Cursor for backward pagination.

after · string

Cursor for forward pagination.

fields · string

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

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/searchIndexes

Python

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

# List first page
indexes = SearchIndexes.list(limit=50)
for si in indexes.data:
    print(f"{si.fullyQualifiedName}")

# List all with auto-pagination
for si in SearchIndexes.list_all():
    print(f"{si.fullyQualifiedName}")

# Filter by service
indexes = SearchIndexes.list(
    service="elasticsearch_sample",
    fields=["owners", "tags", "domain"],
    limit=50
)

for si in indexes.data:
    print(f"{si.fullyQualifiedName}")
    if si.owners:
        print(f"  Owners: {[o.name for o in si.owners]}")
    if si.tags:
        print(f"  Tags: {[t.tagFQN for t in si.tags]}")

Response

{
  "data": [
    {
      "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": [],
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

---

Returns

Returns a paginated list of search index objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data · array

Array of search index objects.

Show properties

id · string

Unique identifier for the search index (UUID format).

name · string

Search index name.

fullyQualifiedName · string

Fully qualified name in format service.indexName.

displayName · string

Human-readable display name.

service · object

Reference to the parent search service.

serviceType · string

Type of search service (e.g., ElasticSearch, OpenSearch).

fields · array

Field definitions for the index schema.

owners · array

List of owners assigned to the search index. Only included when fields contains owners.

tags · array

Classification tags applied. Only included when fields contains tags.

domains · array

Domain assignments for governance. Only included when fields contains domains.

followers · array

Users following this search index. Only included when fields contains followers.

votes · object

User votes and ratings. Only included when fields contains votes.

extension · object

Custom properties. Only included when fields contains extension.

paging · object

Pagination information.

Show properties

total · integer

Total count of search indexes matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.

---

Supported Fields

The following fields can be requested via the fields query parameter:

Field	Description
owners	Owner references (users and teams)
tags	Classification tags
followers	Users following the search index
votes	User votes and ratings
extension	Custom property values
domains	Domain assignments for governance
sourceHash	Hash for change detection

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to list search indexes