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 Metadata Services API

APIs related to creating and managing other Metadata Services that OpenMetadata integrates with such as `Apache Atlas`, `Amundsen`, etc.

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

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

This API exposes 17 operations across 12 paths, and defines 29 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.

17 operations 12 paths 29 schemas 4 DELETE6 GET2 PATCH1 POST4 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 Metadata Services API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

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

Metadata Services 17

APIs related to creating and managing other Metadata Services that OpenMetadata integrates with such as Apache Atlas, Amundsen, etc.

PUT
/v1/services/metadataServices/{id}/followers
Add a follower
addFollowerToMetadataService 1 param body → 200404
PUT
/v1/services/metadataServices/{id}/testConnectionResult
Add test connection result
addTestConnectionResult_7 1 param body → 200
GET
/v1/services/metadataServices
List metadata services
listMetadataServices 5 params → 200
PUT
/v1/services/metadataServices
Update metadata service
createOrUpdateMetadataService body → 200400
POST
/v1/services/metadataServices
Create metadata service
createMetadataService body → 200400
GET
/v1/services/metadataServices/name/{name}
Get a metadata service by name
getMetadataServiceByFQN 4 params → 200404
DELETE
/v1/services/metadataServices/name/{name}
Delete a metadata service by name
deleteMetadataServiceByName 3 params → 200404
GET
/v1/services/metadataServices/{id}
Get a metadata service by Id
getMetadataServiceByID 4 params → 200404
DELETE
/v1/services/metadataServices/{id}
Delete a metadata service by Id
deleteMetadataService 3 params → 200404
PATCH
/v1/services/metadataServices/{id}
Update a metadata service
patchMetadataService_1 1 param body → default
DELETE
/v1/services/metadataServices/async/{id}
Asynchronously delete a metadata service by Id
deleteMetadataServiceAsync 3 params → 200404
DELETE
/v1/services/metadataServices/{id}/followers/{userId}
Remove a follower
deleteFollower_22 2 params → 200
GET
/v1/services/metadataServices/{id}/versions/{version}
Get a version of the metadata service
getSpecificMetadataServiceVersion 2 params → 200404
GET
/v1/services/metadataServices/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_48 5 params → 200
GET
/v1/services/metadataServices/{id}/versions
List metadata service versions
listAllMetadataServiceVersion 1 param → 200
PATCH
/v1/services/metadataServices/name/{fqn}
Update a metadata service using name.
patchMetadataService 1 param body → default
PUT
/v1/services/metadataServices/restore
Restore a soft deleted metadata service.
restore_38 body → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are MetadataService (36 properties), ChangeEvent (14 properties), TagLabel (13 properties), CreateMetadataService (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
CreateMetadataService
object
13 properties 2 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
TestConnectionResult
object
3 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
MetadataConnection
object
1 property
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
MetadataService
object
36 properties 3 required
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
TestConnectionStepResult
object
5 properties 3 required
MetadataServiceList
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-metadata-services-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 Metadata Services 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.