Skip to main content

Containers

A Container represents a storage bucket or directory (e.g., an S3 bucket, GCS bucket, or ADLS container). Containers belong to a Storage Service and can be nested to represent folder hierarchies.
Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Containers belong to a Storage Service and can be nested:
StorageService
└── Container (this page)
    └── Container (nested child)

Fully Qualified Name

The FQN format for a container is:
service.containerName
For nested containers:
service.parentContainer.childContainer
For example: s3_datalake.analytics-bucket or s3_datalake.analytics-bucket.raw-data

API Endpoints

MethodEndpointDescription
PUT/v1/containersCreate or update a container
POST/v1/containersCreate a container (POST variant)
GET/v1/containersList containers
GET/v1/containers/{id}Get by ID
GET/v1/containers/name/{fqn}Get by FQN
PATCH/v1/containers/{id}Update by ID
PATCH/v1/containers/name/{fqn}Update by name
DELETE/v1/containers/{id}Delete by ID
DELETE/v1/containers/name/{fqn}Delete by name
PUT/v1/containers/restoreRestore soft-deleted container
GET/v1/containers/{id}/versionsList versions
GET/v1/containers/{id}/versions/{version}Get specific version
PUT/v1/containers/{id}/followersAdd follower
DELETE/v1/containers/{id}/followers/{userId}Remove follower
PUT/v1/containers/{id}/voteAdd/update vote