POST /v1/containers

from metadata.sdk import configure
from metadata.sdk.entities import Containers
from metadata.generated.schema.api.data.createContainer import CreateContainerRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateContainerRequest(
    name="analytics-bucket",
    displayName="Analytics Bucket",
    service="s3_datalake",
    description="Primary analytics data lake bucket",
    prefix="/analytics/",
    numberOfObjects=150000,
    size=5368709120,
    fileFormats=["parquet", "json"],
    dataModel={
        "isPartitioned": True,
        "columns": [
            {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
            {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
            {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
        ]
    },
    fullPath="s3://analytics-bucket"
)

container = Containers.create(request)
print(f"Created: {container.fullyQualifiedName}")

import static org.openmetadata.sdk.fluent.Containers.*;

// Create using builder pattern
var container = Containers.builder()
    .name("analytics-bucket")
    .displayName("Analytics Bucket")
    .service("s3_datalake")
    .description("Primary analytics data lake bucket")
    .prefix("/analytics/")
    .numberOfObjects(150000)
    .size(5368709120L)
    .fileFormats("parquet", "json")
    .create();

curl -X POST "{base_url}/api/v1/containers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "analytics-bucket",
    "displayName": "Analytics Bucket",
    "service": "s3_datalake",
    "description": "Primary analytics data lake bucket",
    "prefix": "/analytics/",
    "numberOfObjects": 150000,
    "size": 5368709120,
    "fileFormats": ["parquet", "json"],
    "dataModel": {
      "isPartitioned": true,
      "columns": [
        {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
        {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
        {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
      ]
    },
    "fullPath": "s3://analytics-bucket"
  }'

{
  "id": "14744329-85c2-499e-b1fa-249fb8162341",
  "name": "analytics-bucket",
  "displayName": "Analytics Bucket",
  "fullyQualifiedName": "s3_datalake.analytics-bucket",
  "description": "Primary analytics data lake bucket",
  "version": 0.1,
  "updatedAt": 1769982673032,
  "updatedBy": "admin",
  "service": {
    "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
    "type": "storageService",
    "name": "s3_datalake",
    "fullyQualifiedName": "s3_datalake",
    "deleted": false
  },
  "serviceType": "S3",
  "prefix": "/analytics/",
  "numberOfObjects": 150000,
  "size": 5368709120,
  "fileFormats": ["parquet", "json"],
  "dataModel": {
    "isPartitioned": true,
    "columns": [
      {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
      {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
      {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
    ]
  },
  "fullPath": "s3://analytics-bucket",
  "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

POST

containers

POST /v1/containers

from metadata.sdk import configure
from metadata.sdk.entities import Containers
from metadata.generated.schema.api.data.createContainer import CreateContainerRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateContainerRequest(
    name="analytics-bucket",
    displayName="Analytics Bucket",
    service="s3_datalake",
    description="Primary analytics data lake bucket",
    prefix="/analytics/",
    numberOfObjects=150000,
    size=5368709120,
    fileFormats=["parquet", "json"],
    dataModel={
        "isPartitioned": True,
        "columns": [
            {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
            {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
            {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
        ]
    },
    fullPath="s3://analytics-bucket"
)

container = Containers.create(request)
print(f"Created: {container.fullyQualifiedName}")

import static org.openmetadata.sdk.fluent.Containers.*;

// Create using builder pattern
var container = Containers.builder()
    .name("analytics-bucket")
    .displayName("Analytics Bucket")
    .service("s3_datalake")
    .description("Primary analytics data lake bucket")
    .prefix("/analytics/")
    .numberOfObjects(150000)
    .size(5368709120L)
    .fileFormats("parquet", "json")
    .create();

curl -X POST "{base_url}/api/v1/containers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "analytics-bucket",
    "displayName": "Analytics Bucket",
    "service": "s3_datalake",
    "description": "Primary analytics data lake bucket",
    "prefix": "/analytics/",
    "numberOfObjects": 150000,
    "size": 5368709120,
    "fileFormats": ["parquet", "json"],
    "dataModel": {
      "isPartitioned": true,
      "columns": [
        {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
        {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
        {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
      ]
    },
    "fullPath": "s3://analytics-bucket"
  }'

{
  "id": "14744329-85c2-499e-b1fa-249fb8162341",
  "name": "analytics-bucket",
  "displayName": "Analytics Bucket",
  "fullyQualifiedName": "s3_datalake.analytics-bucket",
  "description": "Primary analytics data lake bucket",
  "version": 0.1,
  "updatedAt": 1769982673032,
  "updatedBy": "admin",
  "service": {
    "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
    "type": "storageService",
    "name": "s3_datalake",
    "fullyQualifiedName": "s3_datalake",
    "deleted": false
  },
  "serviceType": "S3",
  "prefix": "/analytics/",
  "numberOfObjects": 150000,
  "size": 5368709120,
  "fileFormats": ["parquet", "json"],
  "dataModel": {
    "isPartitioned": true,
    "columns": [
      {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
      {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
      {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
    ]
  },
  "fullPath": "s3://analytics-bucket",
  "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Create a Container

Create a new container within a storage service.

Body Parameters

string

required

Name of the container. Must be unique within the parent storage service or parent container.

string

required

Fully qualified name of the parent StorageService (e.g., s3_datalake).

string

Human-readable display name for the container.

string

Description of the container in Markdown format.

object

Reference to a parent container for nested containers.

Show properties

string

UUID of the parent container.

string

Type of entity (always container).

string

Path prefix for objects in the container (e.g., /raw/events/).

number

Number of objects stored in the container.

number

Total size of the container in bytes.

array

List of file formats stored in the container (e.g., csv, tsv, parquet, avro, json, jsonl, jsonGz, jsonZip).

object

Data model describing the schema of files in the container.

Show properties

boolean

Whether the data is partitioned.

array

Array of column definitions for the data model.

Show properties

string

required

Column name.

string

required

Data type (e.g., STRING, INT, DOUBLE, TIMESTAMP).

string

Description of the column.

string

Full path of the container (e.g., s3://analytics-bucket/raw/events).

array

Array of owner references (users or teams) to assign to the container.

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

string

Name of the owner entity.

string

Fully qualified name of the domain to assign for governance purposes.

array

Array of classification tags to apply to the container.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label (e.g., Manual, Derived, Propagated).

string

State of the tag (e.g., Suggested, Confirmed).

object

Custom property values defined by your organization’s metadata schema.

POST /v1/containers

from metadata.sdk import configure
from metadata.sdk.entities import Containers
from metadata.generated.schema.api.data.createContainer import CreateContainerRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

request = CreateContainerRequest(
    name="analytics-bucket",
    displayName="Analytics Bucket",
    service="s3_datalake",
    description="Primary analytics data lake bucket",
    prefix="/analytics/",
    numberOfObjects=150000,
    size=5368709120,
    fileFormats=["parquet", "json"],
    dataModel={
        "isPartitioned": True,
        "columns": [
            {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
            {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
            {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
        ]
    },
    fullPath="s3://analytics-bucket"
)

container = Containers.create(request)
print(f"Created: {container.fullyQualifiedName}")

import static org.openmetadata.sdk.fluent.Containers.*;

// Create using builder pattern
var container = Containers.builder()
    .name("analytics-bucket")
    .displayName("Analytics Bucket")
    .service("s3_datalake")
    .description("Primary analytics data lake bucket")
    .prefix("/analytics/")
    .numberOfObjects(150000)
    .size(5368709120L)
    .fileFormats("parquet", "json")
    .create();

curl -X POST "{base_url}/api/v1/containers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "analytics-bucket",
    "displayName": "Analytics Bucket",
    "service": "s3_datalake",
    "description": "Primary analytics data lake bucket",
    "prefix": "/analytics/",
    "numberOfObjects": 150000,
    "size": 5368709120,
    "fileFormats": ["parquet", "json"],
    "dataModel": {
      "isPartitioned": true,
      "columns": [
        {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
        {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
        {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
      ]
    },
    "fullPath": "s3://analytics-bucket"
  }'

{
  "id": "14744329-85c2-499e-b1fa-249fb8162341",
  "name": "analytics-bucket",
  "displayName": "Analytics Bucket",
  "fullyQualifiedName": "s3_datalake.analytics-bucket",
  "description": "Primary analytics data lake bucket",
  "version": 0.1,
  "updatedAt": 1769982673032,
  "updatedBy": "admin",
  "service": {
    "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
    "type": "storageService",
    "name": "s3_datalake",
    "fullyQualifiedName": "s3_datalake",
    "deleted": false
  },
  "serviceType": "S3",
  "prefix": "/analytics/",
  "numberOfObjects": 150000,
  "size": 5368709120,
  "fileFormats": ["parquet", "json"],
  "dataModel": {
    "isPartitioned": true,
    "columns": [
      {"name": "event_id", "dataType": "STRING", "description": "Unique event identifier"},
      {"name": "timestamp", "dataType": "TIMESTAMP", "description": "Event timestamp"},
      {"name": "user_id", "dataType": "STRING", "description": "User identifier"}
    ]
  },
  "fullPath": "s3://analytics-bucket",
  "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Returns

Returns the created container object with all specified properties and system-generated fields.

Response

string

Unique identifier for the container (UUID format).

string

Container name.

string

Fully qualified name in format service.containerName.

string

Human-readable display name.

string

Description of the container in Markdown format.

object

Reference to the parent storage service.

Show properties

string

UUID of the storage service.

string

Type of entity (always storageService).

string

Name of the storage service.

string

Fully qualified name of the storage service.

string

Type of storage service (e.g., S3, GCS, ADLS, CustomStorage).

string

Path prefix for objects in the container.

number

Number of objects stored in the container.

number

Total size of the container in bytes.

array

List of file formats stored in the container.

object

Data model describing the schema of files.

Show properties

boolean

Whether the data is partitioned.

array

Array of column definitions.

string

Full path of the container.

array

List of owners assigned to the container.

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

string

Name of the owner entity.

array

Domain assignments for governance.

array

Classification tags applied to the container.

Show properties

string

Fully qualified name of the tag.

string

Type of label (e.g., Manual, Derived, Propagated).

string

State of the tag (e.g., Suggested, Confirmed).

object

Custom property values defined by your organization’s metadata schema.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/containers instead of POST to perform an upsert. If a container with the same fullyQualifiedName already exists, it will be updated; otherwise, a new container is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/containers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

Bulk Create or Update (PUT)

Use PUT /v1/containers/bulk to create or update multiple containers in a single request. The request body is an array of create request objects.

curl -X PUT "{base_url}/api/v1/containers/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "analytics-bucket", "service": "s3_datalake" },
    { "name": "raw-data-bucket", "service": "s3_datalake" }
  ]'

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create containers
`409`	`ENTITY_ALREADY_EXISTS`	Container with same name already exists in service (POST only)

List Containers

Retrieve a Container

⌘I

​Create a Container

​Body Parameters

​Returns

​Response

​Create or Update (PUT)

​Bulk Create or Update (PUT)

​Error Handling

Create a Container

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling