DigitalOcean API (unofficial showcase)
PUT/v2/databases/{database_cluster_uuid}/topics/{topic_name}

Update a Kafka topic

Updates a Kafka topic's replication factor, partition count, or configuration within a database cluster. Supply the cluster UUID and topic name in the path, and include only the topic settings you want to change. The partition count can only be increased.

2 parameters · 3 body fields
database_cluster_uuidstringrequired
The unique UUID of the database cluster containing the topic.
topic_namestringrequired
The name identifying the Kafka topic to update.

Optional Kafka topic settings to update.

replication_factorintegeroptional
The number of nodes to replicate data across the cluster.
partition_countintegeroptional
The number of partitions available for the topic. On update, this value can only be increased.
configobjectoptional
The topic configuration settings to update, such as cleanup policy, compression type, retention settings, and message settings.

6 status codes
200Returns a JSON object containing the updated topic, including its name, state, replication factor, partitions, and configuration.
topicobjectoptional
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when authentication credentials are invalid. A 404 is returned when the cluster or topic cannot be found. A 429 is returned when the API rate limit is exceeded, and a 500 indicates a server error. The database_cluster_uuid path parameter must be a UUID, and topic_name must identify the Kafka topic; if you provide partition_count, it can only be increased.