PATCH /v1/containers/{id}

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

configure(
    host="https://your-company.getcollate.io/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}")

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

// Retrieve, modify, and update
var container = Containers.retrieve("14744329-85c2-499e-b1fa-249fb8162341");
container.setDescription("Updated: Primary analytics bucket with partitioned parquet data");
var updated = Containers.update(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": []
}

PATCH

containers

{id}

PATCH /v1/containers/{id}

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

configure(
    host="https://your-company.getcollate.io/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}")

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

// Retrieve, modify, and update
var container = Containers.retrieve("14744329-85c2-499e-b1fa-249fb8162341");
container.setDescription("Updated: Primary analytics bucket with partitioned parquet data");
var updated = Containers.update(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

Update a container’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

string

required

UUID of the container to update.

Update by Name

Use PATCH /v1/containers/name/{fqn} to update by fully qualified name.

string

required

Fully qualified name of the container (e.g., s3_datalake.analytics-bucket).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

string

Updated description in Markdown format.

string

Updated display name.

string

Updated path prefix.

number

Updated number of objects.

number

Updated total size in bytes.

array

Updated list of file formats.

object

Updated data model.

Show properties

boolean

Whether the data is partitioned.

array

Array of column definitions.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

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

array

Updated classification tags.

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).

string

Updated domain FQN.

object

Updated custom property values.

PATCH /v1/containers/{id}

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

configure(
    host="https://your-company.getcollate.io/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}")

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

// Retrieve, modify, and update
var container = Containers.retrieve("14744329-85c2-499e-b1fa-249fb8162341");
container.setDescription("Updated: Primary analytics bucket with partitioned parquet data");
var updated = Containers.update(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 JSON patch or malformed request
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this container
`404`	`NOT_FOUND`	Container with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

Retrieve a Container

Delete a Container

⌘I

​Update a Container

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a Container

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling