Skip to main content
GET
GET /v1/containers/{id}

Retrieve a Container

Get a single container by its unique ID or fully qualified name.

Get by ID

id
string
required
UUID of the container to retrieve.
fields
string
Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,dataModel,children,sourceHash).
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/containers/name/{fqn} to retrieve by fully qualified name.
fqn
string
required
Fully qualified name of the container (e.g., s3_datalake.analytics-bucket).
fields
string
Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, dataModel, children, sourceHash.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/containers/{id}

Returns

Returns a container object with all requested fields populated.

Response

id
string
Unique identifier for the container (UUID format).
name
string
Container name.
fullyQualifiedName
string
Fully qualified name in format service.containerName.
displayName
string
Human-readable display name.
description
string
Description of the container in Markdown format.
service
object
Reference to the parent storage service.
serviceType
string
Type of storage service (e.g., S3, GCS, ADLS, CustomStorage).
dataModel
object
Data model with column definitions. Only included when fields contains dataModel.
children
array
Nested child containers. Only included when fields contains children.
version
number
Version number for the entity.
owners
array
List of owners. Only included when fields contains owners.
tags
array
Classification tags. Only included when fields contains tags.
domains
array
Domain assignments. Only included when fields contains domains.

Error Handling