PUT /v1/containers

curl -X PUT "{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"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Containers

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
container = Containers.retrieve("14744329-85c2-499e-b1fa-249fb8162341")
container.description = "Updated: Primary analytics bucket with partitioned parquet data"
container.numberOfObjects = 175000
container.size = 6442450944
updated = Containers.update(container)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.Container;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
Container container = client.containers().get("14744329-85c2-499e-b1fa-249fb8162341");
container.setDescription("Updated: Primary analytics bucket with partitioned parquet data");
Container updated = client.containers().update("14744329-85c2-499e-b1fa-249fb8162341", container);

# Update by ID
curl -X PATCH "{base_url}/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Primary analytics bucket with partitioned parquet data"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/containers/name/s3_datalake.analytics-bucket" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Primary analytics bucket with partitioned parquet data"}
  ]'

{
  "id": "14744329-85c2-499e-b1fa-249fb8162341",
  "name": "analytics-bucket",
  "displayName": "Analytics Bucket",
  "fullyQualifiedName": "s3_datalake.analytics-bucket",
  "description": "Updated: Primary analytics bucket with partitioned parquet data",
  "version": 0.2,
  "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": 175000,
  "size": 6442450944,
  "fileFormats": ["parquet", "json"],
  "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

PUT

containers

PUT /v1/containers

curl -X PUT "{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"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Containers

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
container = Containers.retrieve("14744329-85c2-499e-b1fa-249fb8162341")
container.description = "Updated: Primary analytics bucket with partitioned parquet data"
container.numberOfObjects = 175000
container.size = 6442450944
updated = Containers.update(container)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.Container;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
Container container = client.containers().get("14744329-85c2-499e-b1fa-249fb8162341");
container.setDescription("Updated: Primary analytics bucket with partitioned parquet data");
Container updated = client.containers().update("14744329-85c2-499e-b1fa-249fb8162341", container);

# Update by ID
curl -X PATCH "{base_url}/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Primary analytics bucket with partitioned parquet data"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/containers/name/s3_datalake.analytics-bucket" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Primary analytics bucket with partitioned parquet data"}
  ]'

{
  "id": "14744329-85c2-499e-b1fa-249fb8162341",
  "name": "analytics-bucket",
  "displayName": "Analytics Bucket",
  "fullyQualifiedName": "s3_datalake.analytics-bucket",
  "description": "Updated: Primary analytics bucket with partitioned parquet data",
  "version": 0.2,
  "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": 175000,
  "size": 6442450944,
  "fileFormats": ["parquet", "json"],
  "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Update a Container

Create a container or update it if it already exists, using PUT /v1/containers with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

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, for example 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, for example /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, for example 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, for example STRING, INT, DOUBLE, TIMESTAMP.

string

Description of the column.

string

Full path of the container, for example 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, for example user, team.

string

Name of the owner entity.

array

Fully qualified names of the domains 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, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

object

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

PUT /v1/containers

curl -X PUT "{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"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Containers

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
container = Containers.retrieve("14744329-85c2-499e-b1fa-249fb8162341")
container.description = "Updated: Primary analytics bucket with partitioned parquet data"
container.numberOfObjects = 175000
container.size = 6442450944
updated = Containers.update(container)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.Container;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
Container container = client.containers().get("14744329-85c2-499e-b1fa-249fb8162341");
container.setDescription("Updated: Primary analytics bucket with partitioned parquet data");
Container updated = client.containers().update("14744329-85c2-499e-b1fa-249fb8162341", container);

# Update by ID
curl -X PATCH "{base_url}/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Primary analytics bucket with partitioned parquet data"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/containers/name/s3_datalake.analytics-bucket" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Primary analytics bucket with partitioned parquet data"}
  ]'

{
  "id": "14744329-85c2-499e-b1fa-249fb8162341",
  "name": "analytics-bucket",
  "displayName": "Analytics Bucket",
  "fullyQualifiedName": "s3_datalake.analytics-bucket",
  "description": "Updated: Primary analytics bucket with partitioned parquet data",
  "version": 0.2,
  "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": 175000,
  "size": 6442450944,
  "fileFormats": ["parquet", "json"],
  "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 updated container object with the new version number.

Response

string

Unique identifier for the container (UUID format).

string

Container name.

string

Fully qualified name in format service.containerName.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this container
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Container

Update a Container

Body Parameters

Returns

Response

Error Handling

​Update a Container

​Body Parameters

​Returns

​Response

​Error Handling

Update a Container

Body Parameters

Returns

Response

Error Handling