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

> Update storage service properties using JSON Patch

# Update a Storage Service

Update a storage service'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 storage service to update.
</ParamField>

## Update by Name

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

<ParamField path="fqn" type="string" required>
  Fully qualified name of the storage service (e.g., `s3_datalake`).
</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="connection" type="object">
  Updated connection configuration.

  <Expandable title="properties">
    <ParamField body="config" type="object">
      Service-specific connection configuration.
    </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>

<RequestExample dropdown>
  ```python PATCH /v1/services/storageServices/{id} theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import StorageServices

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

  # Retrieve, modify, and update
  svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106")
  svc.description = "Updated: Production S3 data lake with new region configuration"
  updated = StorageServices.update(svc)

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

  ```java PATCH /v1/services/storageServices/{id} theme={null}
  import static org.openmetadata.sdk.fluent.StorageServices.*;

  // Retrieve, modify, and update
  var svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");
  svc.setDescription("Updated: Production S3 data lake with new region configuration");
  var updated = StorageServices.update(svc);
  ```

  ```bash PATCH /v1/services/storageServices/{id} theme={null}
  # Update by ID
  curl -X PATCH "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated: Production S3 data lake with new region configuration"}
    ]'

  # Update by name
  curl -X PATCH "{base_url}/api/v1/services/storageServices/name/s3_datalake" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated: Production S3 data lake with new region configuration"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
    "name": "s3_datalake",
    "fullyQualifiedName": "s3_datalake",
    "serviceType": "S3",
    "description": "Updated: Production S3 data lake with new region configuration",
    "connection": {
      "config": {
        "type": "S3",
        "awsConfig": {
          "enabled": false,
          "awsAccessKeyId": "AKIA...",
          "awsSecretAccessKey": "*********",
          "awsRegion": "us-east-1",
          "endPointURL": "https://s3.amazonaws.com/"
        }
      }
    },
    "version": 0.2,
    "updatedAt": 1769982621820,
    "updatedBy": "admin",
    "href": "http://localhost:8585/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106",
    "owners": [],
    "tags": [],
    "deleted": false,
    "domains": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the updated storage service object with the new version number.

## Response

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

<ResponseField name="name" type="string">
  Storage service name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name of the service.
</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 storage service |
| `404` | `NOT_FOUND`    | Storage service with given ID or FQN does not exist  |
| `409` | `CONFLICT`     | Concurrent modification detected                     |