GET /v1/searchIndexes
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]}")
import static org.openmetadata.sdk.fluent.SearchIndexes.*;
// List first page
var result = SearchIndexes.list()
.limit(50)
.execute();
for (var si : result.getData()) {
System.out.println(si.getFullyQualifiedName());
}
// Filter by service with fields
var result = SearchIndexes.list()
.service("elasticsearch_sample")
.fields("owners", "tags", "domain")
.limit(50)
.execute();
for (var si : result.getData()) {
System.out.println(si.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/searchIndexes?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/searchIndexes?service=elasticsearch_sample&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/searchIndexes?service=elasticsearch_sample&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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
GET
/
v1
/
searchIndexes
GET /v1/searchIndexes
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]}")
import static org.openmetadata.sdk.fluent.SearchIndexes.*;
// List first page
var result = SearchIndexes.list()
.limit(50)
.execute();
for (var si : result.getData()) {
System.out.println(si.getFullyQualifiedName());
}
// Filter by service with fields
var result = SearchIndexes.list()
.service("elasticsearch_sample")
.fields("owners", "tags", "domain")
.limit(50)
.execute();
for (var si : result.getData()) {
System.out.println(si.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/searchIndexes?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/searchIndexes?service=elasticsearch_sample&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/searchIndexes?service=elasticsearch_sample&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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
Filter by search service fully qualified name.
Maximum number of results to return (max: 1000000).
Cursor for backward pagination.
Cursor for forward pagination.
Comma-separated list of fields to include:
owners, tags, followers, votes, extension, domains, sourceHash. See Supported Fields below.Include
all, deleted, or non-deleted entities.GET /v1/searchIndexes
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]}")
import static org.openmetadata.sdk.fluent.SearchIndexes.*;
// List first page
var result = SearchIndexes.list()
.limit(50)
.execute();
for (var si : result.getData()) {
System.out.println(si.getFullyQualifiedName());
}
// Filter by service with fields
var result = SearchIndexes.list()
.service("elasticsearch_sample")
.fields("owners", "tags", "domain")
.limit(50)
.execute();
for (var si : result.getData()) {
System.out.println(si.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/searchIndexes?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/searchIndexes?service=elasticsearch_sample&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/searchIndexes?service=elasticsearch_sample&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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 thefields parameter to request additional data.
Response
Array of search index objects.
Show properties
Show properties
Unique identifier for the search index (UUID format).
Search index name.
Fully qualified name in format
service.indexName.Human-readable display name.
Reference to the parent search service.
Type of search service (e.g., ElasticSearch, OpenSearch).
Field definitions for the index schema.
List of owners assigned to the search index. Only included when
fields contains owners.Classification tags applied. Only included when
fields contains tags.Domain assignments for governance. Only included when
fields contains domains.Users following this search index. Only included when
fields contains followers.User votes and ratings. Only included when
fields contains votes.Custom properties. Only included when
fields contains extension.Supported Fields
The following fields can be requested via thefields 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 |
Was this page helpful?
⌘I