Skip to main content
PATCH
https://sandbox.getcollate.io/api
/
v1
/
services
/
storageServices
/
{id}
PATCH /v1/services/storageServices/{id}
from metadata.sdk import configure
from metadata.sdk.entities import StorageServices

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

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

id
string
required
UUID of the storage service to update.

Update by Name

Use PATCH /v1/services/storageServices/name/{fqn} to update by fully qualified name.
fqn
string
required
Fully qualified name of the storage service (e.g., s3_datalake).

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.
connection
object
Updated connection configuration.
owners
array
Updated list of owner references.
tags
array
Updated classification tags.
domain
string
Updated domain FQN.
PATCH /v1/services/storageServices/{id}
from metadata.sdk import configure
from metadata.sdk.entities import StorageServices

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

Returns

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

Response

id
string
Unique identifier for the storage service (UUID format).
name
string
Storage service name.
fullyQualifiedName
string
Fully qualified name of the service.
description
string
Updated description.
version
number
Incremented version number.

Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this storage service
404NOT_FOUNDStorage service with given ID or FQN does not exist
409CONFLICTConcurrent modification detected