OpenMetadata

OpenMetadata Search Index API

A `SearchIndex` is a index mapping for indexing documents in a `Search Service`.

GitHub OpenAPI

Operations 20

PUT /v1/searchIndexes/{id}/followers Add a follower #
GET /v1/searchIndexes/{id}/sampleData Get sample data #
PUT /v1/searchIndexes/{id}/sampleData Add sample data #
PUT /v1/searchIndexes/bulk Bulk create or update search indexes #
GET /v1/searchIndexes List searchIndexes #
PUT /v1/searchIndexes Update SearchIndex #
POST /v1/searchIndexes Create a SearchIndex #
GET /v1/searchIndexes/name/{fqn} Get a SearchIndex by fully qualified name #
DELETE /v1/searchIndexes/name/{fqn} Delete a SearchIndex by fully qualified name #
PATCH /v1/searchIndexes/name/{fqn} Update a SearchIndex using name #
GET /v1/searchIndexes/{id} Get a SearchIndex by id #
DELETE /v1/searchIndexes/{id} Delete a SearchIndex by id #
PATCH /v1/searchIndexes/{id} Update a SearchIndex #
DELETE /v1/searchIndexes/async/{id} Asynchronously delete a SearchIndex by id #
DELETE /v1/searchIndexes/{id}/followers/{userId} Remove a follower #
GET /v1/searchIndexes/{id}/versions/{version} Get a version of the SearchIndex #
GET /v1/searchIndexes/history List all entity versions within a time range #
GET /v1/searchIndexes/{id}/versions List SearchIndex versions #
PUT /v1/searchIndexes/restore Restore a soft deleted SearchIndex #
PUT /v1/searchIndexes/{id}/vote Update Vote for a Entity #

Documentation

📖
Documentation
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
📖
Authentication
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-search-index-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openmetadata-search-index-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openmetadata-search-index-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenMetadata Search Index API
  description: Common types and API definition for OpenMetadata
  contact:
    name: OpenMetadata
    url: https://open-metadata.org
    email: openmetadata-dev@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.13'
servers:
- url: /api
  description: Current Host
- url: http://localhost:8585/api
  description: Endpoint URL
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-search-index-api-openapi.yml