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 API Endpoint API

A `API Endpoint` is a specific endpoint of an API that is part of an API Collection..

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

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

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

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

Paths & Operations 18

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

API Endpoint 18

A API Endpoint is a specific endpoint of an API that is part of an API Collection..

PUT
/v1/apiEndpoints/{id}/followers
Add a follower
addFollower_5 1 param body → 200404
PUT
/v1/apiEndpoints/bulk
Bulk create or update API endpoints
bulkCreateOrUpdateAPIEndpoints 1 param body → 200202400
GET
/v1/apiEndpoints
List API Endpoints
listAPIEndpoints 7 params → 200
PUT
/v1/apiEndpoints
Update API Endpoint
createOrUpdateAPIEndpoint body → 200
POST
/v1/apiEndpoints
Create a API Endpoint
createAPIEndpoint body → 200400
GET
/v1/apiEndpoints/name/{fqn}
Get a Endpoint by fully qualified name.
getEndpointByFQN 4 params → 200404
DELETE
/v1/apiEndpoints/name/{fqn}
Delete a APIEndpoint by fully qualified name
deleteAPIEndpointByFQN 2 params → 200404
PATCH
/v1/apiEndpoints/name/{fqn}
Update a APIEndpoint using name.
patchAPIEndpoint 1 param body → default
GET
/v1/apiEndpoints/{id}
Get a APIEndpoint by id
getEndpointById 4 params → 200404
DELETE
/v1/apiEndpoints/{id}
Delete a APIEndpoint by id
deleteAPIEndpoint 2 params → 200404
PATCH
/v1/apiEndpoints/{id}
Update a APIEndpoint
patchAPIEndpoint_1 1 param body → default
DELETE
/v1/apiEndpoints/async/{id}
Asynchronously delete a APIEndpoint by id
deleteAPIEndpointAsync 2 params → 200404
DELETE
/v1/apiEndpoints/{id}/followers/{userId}
Remove a follower
deleteFollower_5 2 params → 200
GET
/v1/apiEndpoints/{id}/versions/{version}
Get a version of the APIEndpoint
getSpecificEndpointVersion 2 params → 200404
GET
/v1/apiEndpoints/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_6 5 params → 200
GET
/v1/apiEndpoints/{id}/versions
List API Endpoint versions
listAllAPIEndpointVersion 1 param → 200
PUT
/v1/apiEndpoints/restore
Restore a soft deleted APIEndpoint
restore_5 body → 200
PUT
/v1/apiEndpoints/{id}/vote
Update Vote for a APIEndpoint
updateVoteForAPIEndpoint 1 param body → 200404

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are APIEndpoint (38 properties), CreateAPIEndpoint (17 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
BulkOperationResult
object
8 properties
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
APISchema
object
2 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
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
CreateAPIEndpoint
object
17 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
Field
object
8 properties 2 required
APIEndpointList
object
5 properties 1 required
APIEndpoint
object
38 properties 3 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-api-endpoint-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 Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
OpenMetadata Columns API
Where this information came from

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