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

OpenMetadata Document Store API

A `Document` is an generic entity in OpenMetadata.

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

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

This API exposes 15 operations across 10 paths, and defines 28 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.

15 operations 10 paths 28 schemas 3 DELETE6 GET2 PATCH2 POST2 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
License
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 15

Across 10 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 2 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Document Store 15

A Document is an generic entity in OpenMetadata.

GET
/v1/docStore
List Documents
listDocuments 5 params → 200
PUT
/v1/docStore
Update Document
createOrUpdateDocument body → 200400
POST
/v1/docStore
Create a Document
createDocument body → 200400
GET
/v1/docStore/name/{name}
Get a Document by name
getDocumentByFQN 2 params → 200404
DELETE
/v1/docStore/name/{name}
Delete a Document by name
deleteDocumentByName 1 param → 200404
GET
/v1/docStore/{id}
Get a Document by id
get_2 2 params → 200404
DELETE
/v1/docStore/{id}
Delete a Document by id
deleteDocument 1 param → 200404
PATCH
/v1/docStore/{id}
Update a Document.
patchDocument_1 1 param body → default
DELETE
/v1/docStore/async/{id}
Asynchronously delete a Document by id
deleteDocumentAsync 1 param → 200404
GET
/v1/docStore/{id}/versions/{version}
Get a version of the Document
getSpecificDocumentVersion 2 params → 200404
GET
/v1/docStore/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_18 5 params → 200
GET
/v1/docStore/{id}/versions
List Document versions
listAllDocumentVersion 1 param → 200
PATCH
/v1/docStore/name/{fqn}
Update a Document by name.
patchDocument 1 param body → default
POST
/v1/docStore/resetEmailTemplate
Reset seed data of EmailTemplate type
resetEmailTemplate → 200400
PUT
/v1/docStore/validateTemplate/{templateName}
Validate Email Template
validateEmailTemplate 1 param body → 200400

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Document (33 properties), TagLabel (13 properties), CreateDocument (13 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
Document
object
33 properties 4 required
Data
object
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
CreateDocument
object
13 properties 4 required
FieldChange
object
3 properties
CoverImage
object
2 properties
TemplateValidationResponse
object
4 properties
LifeCycle
object
3 properties
EmailTemplate
object
2 properties 2 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
EmailTemplatePlaceholder
object
2 properties 2 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
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required
DocumentList
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-document-store-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Document Store 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.