How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenMetadata

OpenMetadata SearchIndex API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenMetadata SearchIndex API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SearchIndex. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 20 operations across 13 paths, and defines 32 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

20 operations 13 paths 32 schemas 4 DELETE7 GET2 PATCH1 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
Contact
OpenMetadata
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

OpenMetadata SearchIndex API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 13 paths, the API surfaces 20 operations — 4 DELETE, 7 GET, 2 PATCH, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

SearchIndex 20

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

PUT
/v1/searchIndexes/{id}/followers
Add a follower
addFollower_11 1 param body → 200404
GET
/v1/searchIndexes/{id}/sampleData
Get sample data
getSampleData_2 1 param → 200
PUT
/v1/searchIndexes/{id}/sampleData
Add sample data
addSampleData_2 1 param body → 200
PUT
/v1/searchIndexes/bulk
Bulk create or update search indexes
bulkCreateOrUpdateSearchIndexes 1 param body → 200202400
GET
/v1/searchIndexes
List searchIndexes
listSearchIndexes 6 params → 200
PUT
/v1/searchIndexes
Update SearchIndex
createOrUpdateSearchIndex body → 200
POST
/v1/searchIndexes
Create a SearchIndex
createSearchIndex body → 200400
GET
/v1/searchIndexes/name/{fqn}
Get a SearchIndex by fully qualified name
getSearchIndexByFQN 4 params → 200404
DELETE
/v1/searchIndexes/name/{fqn}
Delete a SearchIndex by fully qualified name
deleteSearchIndexByFQN 3 params → 200404
PATCH
/v1/searchIndexes/name/{fqn}
Update a SearchIndex using name.
patchSearchIndex 1 param body → default
GET
/v1/searchIndexes/{id}
Get a SearchIndex by id
get_6 4 params → 200404
DELETE
/v1/searchIndexes/{id}
Delete a SearchIndex by id
deleteSearchIndex 3 params → 200404
PATCH
/v1/searchIndexes/{id}
Update a SearchIndex
patchSearchIndex_1 1 param body → default
DELETE
/v1/searchIndexes/async/{id}
Asynchronously delete a SearchIndex by id
deleteSearchIndexAsync 3 params → 200404
DELETE
/v1/searchIndexes/{id}/followers/{userId}
Remove a follower
deleteFollower_14 2 params → 200
GET
/v1/searchIndexes/{id}/versions/{version}
Get a version of the SearchIndex
getSpecificSearchIndexVersion 2 params → 200404
GET
/v1/searchIndexes/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_39 5 params → 200
GET
/v1/searchIndexes/{id}/versions
List SearchIndex versions
listAllSearchIndexVersion 1 param → 200
PUT
/v1/searchIndexes/restore
Restore a soft deleted SearchIndex
restore_29 body → 200
PUT
/v1/searchIndexes/{id}/vote
Update Vote for a Entity
updateVoteForEntity_15 1 param body → 200404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are SearchIndex (37 properties), CreateSearchIndex (15 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
SearchIndexField
object
8 properties 2 required
BulkOperationResult
object
8 properties
SearchIndexSettings
object
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
Paging
object
5 properties 1 required
SearchIndexSampleData
object
1 property
SearchIndex
object
37 properties 4 required
JsonPatch
object
ChangeDescription
object
5 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
CreateSearchIndex
object
15 properties 3 required
SearchIndexList
object
5 properties 1 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-searchindex-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
AE Profile APIs.io
OpenMetadata AI Applications API
AE Profile APIs.io
OpenMetadata AI Governance Policies API
AE Profile APIs.io
OpenMetadata API Collections API
AE Profile APIs.io
OpenMetadata API Endpoint API
AE Profile APIs.io
OpenMetadata API Services API
AE Profile APIs.io
OpenMetadata Apps API
AE Profile APIs.io
OpenMetadata Audit Logs API
AE Profile APIs.io
OpenMetadata Bots API
AE Profile APIs.io
OpenMetadata ChangeSummary API
AE Profile APIs.io
OpenMetadata Charts API
AE Profile APIs.io
OpenMetadata Classifications API
AE Profile APIs.io
#SearchIndex
← Back to O APIs
API Details
ID
openmetadata:openmetadata-searchindex-api
Base URL
https://{your-host}/api/v1
Docs
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
Provider
OpenMetadata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openmetadata-searchindex-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmetadata-searchindex-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of OpenMetadata SearchIndex API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.