Skip to main content
POST
Change Kafka topic settings

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Path Parameters

topic
string
required
uuid
string
required

Body

application/json
localRetentionMS
null | integer

How long the tiered topic keeps data on broker disks: from 86400000 (one day) up to retention. Turning tiered storage on without it uses 7 days, capped at retention; on a Managed Kafka cluster it uses the cluster's days on disk.

retentionMS
null | integer

New retention.ms: at least 86400000 (one day); or -1 to keep messages forever.

tieredStorage
null | enum<string>

off, on or paused. A topic that's on can only be paused, and only a paused topic can be turned off, which deletes its data in remote storage. Pausing keeps that data readable until retention expires it.

Available options:
off,
on,
paused,
null

Response

OK

artieManaged
boolean
required

Whether Artie manages this topic: a CDC topic under the company prefix outside the customer namespace, or a Kafka-internal __ topic.

partitionCount
integer
required
retentionMS
string
required
tieredStorage
object
required
topic
string
required
localRetentionMS
string

How long a tiered topic keeps data on broker disks (local.retention.ms). -2 means the same as retention. Left out when the brokers don't report it.

sourceName
string
tableName
string