Skip to main content
GET
GET /v1/searchIndexes/{id}

Retrieve a Search Index

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

Get by ID

id
string
required
UUID of the search index to retrieve.
fields
string
Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,sourceHash).
include
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.
fqn
string
required
Fully qualified name of the search index (e.g., elasticsearch_sample.table_search_index).
fields
string
Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, sourceHash.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/searchIndexes/{id}

Returns

Returns a search index object with all requested fields populated.

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.
displayName
string
Human-readable display name.
description
string
Description of the search index in Markdown format.
service
object
Reference to the parent search service.
fields
array
Field definitions for the index schema.
serviceType
string
Type of search service (e.g., ElasticSearch, OpenSearch).
version
number
Version number for the entity.
owners
array
List of owners. Only included when fields contains owners.
tags
array
Classification tags. Only included when fields contains tags.
domains
array
Domain assignments. Only included when fields contains domains.

Error Handling