PATCH /v1/services/messagingServices/{id}
import requests
base_url = "https://your-company.getcollate.io/api"
headers = {
"Authorization": "Bearer your-jwt-token",
"Content-Type": "application/json-patch+json"
}
# Update by ID
response = requests.patch(
f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
json=[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
{"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
],
headers=headers
)
updated = response.json()
print(f"Updated to version {updated['version']}")
import org.openmetadata.schema.entity.services.MessagingService;
import org.openmetadata.sdk.fluent.MessagingServices;
// client is an initialized OpenMetadataClient.
MessagingServices.setDefaultClient(client);
// Retrieve, modify, and update
MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");
service.setDescription("Updated Kafka messaging service");
MessagingService updated = MessagingServices.update(service);
# Update by ID
curl -X PATCH "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
{"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
]'
# Update by name
curl -X PATCH "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"}
]'
{
"id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
"name": "sample_kafka",
"fullyQualifiedName": "sample_kafka",
"serviceType": "Kafka",
"description": "Updated Kafka messaging service",
"version": 0.2,
"updatedAt": 1769982700000,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
"connection": {
"config": {
"type": "Kafka",
"bootstrapServers": "localhost:9092",
"securityProtocol": "PLAINTEXT",
"saslMechanism": "PLAIN",
"schemaRegistryTopicSuffixName": "-value",
"supportsMetadataExtraction": true
}
},
"owners": [],
"tags": [],
"deleted": false,
"domains": []
}
Update a Messaging Service
Update messaging service connection properties using JSON Patch operations to modify configuration, authentication, owners, and tags via the Collate REST API.
PATCH
/
v1
/
services
/
messagingServices
/
{id}
PATCH /v1/services/messagingServices/{id}
import requests
base_url = "https://your-company.getcollate.io/api"
headers = {
"Authorization": "Bearer your-jwt-token",
"Content-Type": "application/json-patch+json"
}
# Update by ID
response = requests.patch(
f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
json=[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
{"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
],
headers=headers
)
updated = response.json()
print(f"Updated to version {updated['version']}")
import org.openmetadata.schema.entity.services.MessagingService;
import org.openmetadata.sdk.fluent.MessagingServices;
// client is an initialized OpenMetadataClient.
MessagingServices.setDefaultClient(client);
// Retrieve, modify, and update
MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");
service.setDescription("Updated Kafka messaging service");
MessagingService updated = MessagingServices.update(service);
# Update by ID
curl -X PATCH "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
{"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
]'
# Update by name
curl -X PATCH "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"}
]'
{
"id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
"name": "sample_kafka",
"fullyQualifiedName": "sample_kafka",
"serviceType": "Kafka",
"description": "Updated Kafka messaging service",
"version": 0.2,
"updatedAt": 1769982700000,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
"connection": {
"config": {
"type": "Kafka",
"bootstrapServers": "localhost:9092",
"securityProtocol": "PLAINTEXT",
"saslMechanism": "PLAIN",
"schemaRegistryTopicSuffixName": "-value",
"supportsMetadataExtraction": true
}
},
"owners": [],
"tags": [],
"deleted": false,
"domains": []
}
Update a Messaging Service
Update a messaging 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/messagingServices/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/messagingServices/{id}
import requests
base_url = "https://your-company.getcollate.io/api"
headers = {
"Authorization": "Bearer your-jwt-token",
"Content-Type": "application/json-patch+json"
}
# Update by ID
response = requests.patch(
f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
json=[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
{"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
],
headers=headers
)
updated = response.json()
print(f"Updated to version {updated['version']}")
import org.openmetadata.schema.entity.services.MessagingService;
import org.openmetadata.sdk.fluent.MessagingServices;
// client is an initialized OpenMetadataClient.
MessagingServices.setDefaultClient(client);
// Retrieve, modify, and update
MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");
service.setDescription("Updated Kafka messaging service");
MessagingService updated = MessagingServices.update(service);
# Update by ID
curl -X PATCH "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
{"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
]'
# Update by name
curl -X PATCH "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json-patch+json" \
-d '[
{"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"}
]'
{
"id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
"name": "sample_kafka",
"fullyQualifiedName": "sample_kafka",
"serviceType": "Kafka",
"description": "Updated Kafka messaging service",
"version": 0.2,
"updatedAt": 1769982700000,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
"connection": {
"config": {
"type": "Kafka",
"bootstrapServers": "localhost:9092",
"securityProtocol": "PLAINTEXT",
"saslMechanism": "PLAIN",
"schemaRegistryTopicSuffixName": "-value",
"supportsMetadataExtraction": true
}
},
"owners": [],
"tags": [],
"deleted": false,
"domains": []
}
Returns
Returns the updated messaging 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 messaging service |
404 | NOT_FOUND | Messaging service with given ID or FQN does not exist |
409 | CONFLICT | Concurrent modification detected |
Was this page helpful?