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

A Container is an abstraction for any path(including the top level eg. bucket in S3) storing data in an Object store such as S3, GCP, Azure. It maps a tree-like structure, where each Container can have a parent and a list of sub-folders, and it can be structured - where it contains structured data, or unstructured where no schema for its data is defined.

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

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

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

23 operations 15 paths 37 schemas 5 DELETE9 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
License
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 23

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

Containers 23

A Container is an abstraction for any path(including the top level eg. bucket in S3) storing data in an Object store such as S3, GCP, Azure. It maps a tree-like structure, where e…

PUT
/v1/containers/{id}/followers
Add a follower
addFollower_12 1 param body → 200404
GET
/v1/containers/{id}/sampleData
Get sample data
getSampleData_3 1 param → 200
PUT
/v1/containers/{id}/sampleData
Add sample data
addSampleData_3 1 param body → 200
DELETE
/v1/containers/{id}/sampleData
Delete sample data
deleteSampleData_2 1 param → 200
PUT
/v1/containers/bulk
Bulk create or update containers
bulkCreateOrUpdateContainers 1 param body → 200202400
GET
/v1/containers
List Containers
listContainers 7 params → 200
PUT
/v1/containers
Create or update a Container
createOrUpdateContainer body → 200400
POST
/v1/containers
Create a Container
createContainer body → 200400
GET
/v1/containers/name/{fqn}
Get an Container by name
getContainerByFQN 4 params → 200404
DELETE
/v1/containers/name/{fqn}
Delete a Container by fully qualified name
deleteContainerByFQN 2 params → 200404
PATCH
/v1/containers/name/{fqn}
Update a Container using name.
patchContainer 1 param body → default
GET
/v1/containers/{id}
Get an Object Store Container
getContainerByID 4 params → 200404
DELETE
/v1/containers/{id}
Delete a Container
deleteContainer 3 params → 200404
PATCH
/v1/containers/{id}
Update a Container
patchContainer_1 1 param body → default
DELETE
/v1/containers/async/{id}
Asynchronously delete a Container
deleteContainerAsync 3 params → 200404
DELETE
/v1/containers/{id}/followers/{userId}
Remove a follower
deleteFollower_28 2 params → 200
GET
/v1/containers/{id}/versions/{version}
Get a version of the Container
getSpecificContainerVersion 2 params → 200404
GET
/v1/containers/name/{fqn}/ancestors
List ancestor containers (parent chain)
listContainerAncestors 1 param → 200
GET
/v1/containers/name/{fqn}/children
List children containers
listContainerChildren 5 params → 200
GET
/v1/containers/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_54 5 params → 200
GET
/v1/containers/{id}/versions
List Container versions
listAllContainerVersion 1 param → 200
PUT
/v1/containers/restore
Restore a soft deleted Container.
restore_44 body → 200
PUT
/v1/containers/{id}/vote
Update Vote for a Entity
updateVoteForEntity_16 1 param body → 200404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Container (43 properties), ColumnProfile (30 properties), CreateContainer (20 properties), Column (18 properties). Each schema is shown below with its type and property counts.

ContainerDataModel
object
2 properties 1 required
TagLabelRecognizerMetadata
object
5 properties 3 required
CreateContainer
object
20 properties 2 required
ColumnProfile
object
30 properties 2 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
CustomMetricProfile
object
2 properties
VoteRequest
object
1 property
CardinalityDistribution
object
4 properties
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
TableData
object
2 properties
Paging
object
5 properties 1 required
JsonPatch
object
CustomMetric
object
8 properties 2 required
ChangeDescription
object
5 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
ContainerList
object
5 properties 1 required
Style
object
3 properties
Column
object
18 properties 2 required
Votes
object
4 properties
Histogram
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
Container
object
43 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-containers-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 Containers 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.