Skip to main content
PUT
PUT /v1/services/messagingServices

Update a Messaging Service

Create a messaging service or update it if it already exists, using PUT /v1/services/messagingServices with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string
required
Name of the messaging service. Must be unique across all messaging services.
string
required
Type of messaging service, for example Kafka, Redpanda, Kinesis, CustomMessaging.
string
Description of the messaging service in Markdown format.
string
Human-readable display name for the messaging service.
object
required
Connection configuration specific to the service type.
array
Array of owner references (users or teams) to assign to the service.
array
Fully qualified names of the domains to assign for governance purposes.
array
Array of classification tags to apply to the messaging service.
PUT /v1/services/messagingServices

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