Topics

Update topic

Create a topic, it it does not exist or update an existing topic.

put/v1/topics

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/topics
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
servicestring required
partitionsinteger required
cleanupPoliciesstring[]
replicationFactorinteger
retentionTimenumber double
maximumMessageSizeinteger
minimumInSyncReplicasinteger
retentionSizenumber double
topicConfigTopicConfig
extensionobject
sourceUrlstring
domainsstring[]
dataProductsstring[]
sourceHashstring

Response

The updated topic

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
serviceType'Kafka' | 'Redpanda' | 'Kinesis' | 'PubSub' | 'CustomMessaging'
partitionsinteger required
cleanupPoliciesstring[]
retentionTimenumber double
replicationFactorinteger
maximumMessageSizeinteger
minimumInSyncReplicasinteger
retentionSizenumber double
topicConfigTopicConfig
hrefstring uri
deletedboolean
extensionobject
sourceUrlstring
sourceHashstring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.