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.root}")
import org.openmetadata.schema.entity.services.StorageService;
import org.openmetadata.sdk.fluent.StorageServices;
// client is an initialized OpenMetadataClient.
StorageServices.setDefaultClient(client);
// Retrieve, modify, and update
StorageService service = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");
service.setDescription("Updated: Production S3 data lake with new region configuration");
StorageService updated = StorageServices.update(service);
# 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"}
]'
{
"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 storage service connection properties using JSON Patch operations to modify configuration, authentication, owners, and tags via the Collate REST API.
PATCH
/
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.root}")
import org.openmetadata.schema.entity.services.StorageService;
import org.openmetadata.sdk.fluent.StorageServices;
// client is an initialized OpenMetadataClient.
StorageServices.setDefaultClient(client);
// Retrieve, modify, and update
StorageService service = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");
service.setDescription("Updated: Production S3 data lake with new region configuration");
StorageService updated = StorageServices.update(service);
# 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"}
]'
{
"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
Update by Name
UsePATCH /v1/services/storageServices/name/{fqn} to update by fully qualified name.
Body Parameters
Send a JSON object with the fields to update. Only provided fields are changed.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.root}")
import org.openmetadata.schema.entity.services.StorageService;
import org.openmetadata.sdk.fluent.StorageServices;
// client is an initialized OpenMetadataClient.
StorageServices.setDefaultClient(client);
// Retrieve, modify, and update
StorageService service = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");
service.setDescription("Updated: Production S3 data lake with new region configuration");
StorageService updated = StorageServices.update(service);
# 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"}
]'
{
"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
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 |
Was this page helpful?