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 static org.openmetadata.sdk.fluent.MessagingServices.*;

// 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": []
}

PATCH

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 static org.openmetadata.sdk.fluent.MessagingServices.*;

// 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

string

required

UUID of the messaging service to update.

Update by Name

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

string

required

Fully qualified name of the messaging service (e.g., sample_kafka).

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

object

Service-specific connection configuration.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

array

Updated classification tags.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label (e.g., Manual, Derived, Propagated).

string

State of the tag (e.g., Suggested, Confirmed).

string

Updated domain FQN.

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 static org.openmetadata.sdk.fluent.MessagingServices.*;

// 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

string

Unique identifier for the messaging service (UUID format).

string

Messaging 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 messaging service
`404`	`NOT_FOUND`	Messaging service with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

Retrieve a Messaging Service

Delete a Messaging Service

⌘I

​Update a Messaging Service

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a Messaging Service

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling