Skip to main content
PUT
PUT /v1/topics

Update a Topic

Create a topic or update it if it already exists, using PUT /v1/topics 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 topic. Must be unique within the parent messaging service.
string
required
Fully qualified name of the parent MessagingService, for example sample_kafka.
object
Schema definition for messages in the topic.
integer
required
Number of partitions for the topic.
array
Array of cleanup policies for the topic, for example delete, compact.
integer
Replication factor for the topic.
integer
Maximum message size in bytes.
integer
Retention size in bytes. Use -1 for unlimited.
string
Human-readable display name for the topic.
string
Description of the topic in Markdown format.
array
Array of owner references (users or teams) to assign to the topic.
array
Fully qualified names of the domains to assign for governance purposes.
array
Array of classification tags to apply to the topic.
object
Custom property values defined by your organization’s metadata schema.
PUT /v1/topics

Returns

Returns the updated topic object with the new version number.

Response

string
Unique identifier for the topic (UUID format).
string
Topic name.
string
Fully qualified name in format service.topicName.
string
Updated description.
number
Incremented version number.

Error Handling