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

A `API Collection` is an optional way of grouping API Endpoints that belong to a API Service.

OpenMetadata API Collections 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 Collections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 16 operations across 10 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.

16 operations 10 paths 29 schemas 3 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 API Collections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 16

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

API Collections 16

A API Collection is an optional way of grouping API Endpoints that belong to a API Service.

PUT
/v1/apiCollections/bulk
Bulk create or update API collections
bulkCreateOrUpdateAPICollections 1 param body → 200202400
GET
/v1/apiCollections
List API Collections
listAPICollections 6 params → 200
PUT
/v1/apiCollections
Create or update API Collection
createOrUpdateAPICollection body → 200
POST
/v1/apiCollections
Create a APICollection
createAPICollection body → 200400
GET
/v1/apiCollections/name/{fqn}
Get a APICollection by fully qualified name
getAPICollectionByFQN 4 params → 200404
DELETE
/v1/apiCollections/name/{fqn}
Delete a API Collection by fully qualified name
deleteAPICollectionByFQN 3 params → 200404
PATCH
/v1/apiCollections/name/{fqn}
Update a APICollection by name.
patchAPICollection 1 param body → default
GET
/v1/apiCollections/{id}
Get a API Collection by Id
getAPICollectionByID 4 params → 200404
DELETE
/v1/apiCollections/{id}
Delete a API Collection by Id
deleteAPICollection 3 params → 200404
PATCH
/v1/apiCollections/{id}
Update a API Collection by Id
patchAPICollection_1 1 param body → default
DELETE
/v1/apiCollections/async/{id}
Asynchronously delete a API Collection by Id
deleteAPICollectionAsync 3 params → 200404
GET
/v1/apiCollections/{id}/versions/{version}
Get a version of the APICollection
getSpecificAPICollectionVersion 2 params → 200404
GET
/v1/apiCollections/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_5 5 params → 200
GET
/v1/apiCollections/{id}/versions
List API Collection versions
listAllAPICollectionVersion 1 param → 200
PUT
/v1/apiCollections/restore
Restore a soft deleted API Collection.
restore_4 body → 200
PUT
/v1/apiCollections/{id}/vote
Update Vote for a API Collection
updateVoteForAPICollection 1 param body → 200404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are APICollection (35 properties), ChangeEvent (14 properties), CreateAPICollection (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
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
APICollection
object
35 properties 3 required
CreateAPICollection
object
14 properties 2 required
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
APICollectionList
object
5 properties 1 required
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-api-collections-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 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
OpenMetadata Columns API
Where this information came from

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