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

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

id
string
required
UUID of the container to update.

Update by Name

Use PATCH /v1/containers/name/{fqn} to update by fully qualified name.
fqn
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.
description
string
Updated description in Markdown format.
displayName
string
Updated display name.
prefix
string
Updated path prefix.
numberOfObjects
number
Updated number of objects.
size
number
Updated total size in bytes.
fileFormats
array
Updated list of file formats.
dataModel
object
Updated data model.
owners
array
Updated list of owner references.
tags
array
Updated classification tags.
domain
string
Updated domain FQN.
extension
object
Updated custom property values.
PATCH /v1/containers/{id}

Returns

Returns the updated container object with the new version number.

Response

id
string
Unique identifier for the container (UUID format).
name
string
Container name.
fullyQualifiedName
string
Fully qualified name in format service.containerName.
description
string
Updated description.
version
number
Incremented version number.

Error Handling