> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a Container

> Update container properties using JSON Patch

# 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

<ParamField path="id" type="string" required>
  UUID of the container to update.
</ParamField>

## Update by Name

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

<ParamField path="fqn" type="string" required>
  Fully qualified name of the container (e.g., `s3_datalake.analytics-bucket`).
</ParamField>

## Body Parameters

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

<ParamField body="description" type="string">
  Updated description in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Updated display name.
</ParamField>

<ParamField body="prefix" type="string">
  Updated path prefix.
</ParamField>

<ParamField body="numberOfObjects" type="number">
  Updated number of objects.
</ParamField>

<ParamField body="size" type="number">
  Updated total size in bytes.
</ParamField>

<ParamField body="fileFormats" type="array">
  Updated list of file formats.
</ParamField>

<ParamField body="dataModel" type="object">
  Updated data model.

  <Expandable title="properties">
    <ParamField body="isPartitioned" type="boolean">
      Whether the data is partitioned.
    </ParamField>

    <ParamField body="columns" type="array">
      Array of column definitions.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="owners" type="array">
  Updated list of owner references.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="tags" type="array">
  Updated classification tags.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Updated domain FQN.
</ParamField>

<ParamField body="extension" type="object">
  Updated custom property values.
</ParamField>

<RequestExample dropdown>
  ```python PATCH /v1/containers/{id} theme={null}
  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}")
  ```

  ```java PATCH /v1/containers/{id} theme={null}
  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);
  ```

  ```bash PATCH /v1/containers/{id} theme={null}
  # 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"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the updated container object with the new version number.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the container (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Container name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.containerName`.
</ResponseField>

<ResponseField name="description" type="string">
  Updated description.
</ResponseField>

<ResponseField name="version" type="number">
  Incremented version number.
</ResponseField>

***

## 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               |