PATCH /v1/services/storageServices/{id}
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}")
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);
# 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 properties using JSON Patch
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.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}")
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);
# 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
string
required
UUID of the storage service to update.
Update by Name
UsePATCH /v1/services/storageServices/name/{fqn} to update by fully qualified name.
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.string
Updated description in Markdown format.
string
Updated display name.
object
Updated connection configuration.
Show properties
Show properties
object
Service-specific connection configuration.
array
array
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.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}")
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);
# 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
string
Unique identifier for the storage service (UUID format).
string
Storage service name.
string
Fully qualified name of the service.
string
Updated description.
number
Incremented version number.
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?
⌘I