Apache Kafka Topic V2

Get a list of Kafka topics

Retrieve a list of the kafka Topic names in the given cluster.

SecurityBasic Authentication

Request

path Parameters

clusterId

required

string <uuid>

ID of the Kafka cluster

Responses

200

Kafka topic list retrieved

get/cluster-management/v2/data-sources/kafka_cluster/{clusterId}/topics/v2

Request samples

Response samples

application/json

[{"clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
"topicNames": ["__consumer_offsets",
"instaclustr-sla"
]
}
]

Update Kafka topic configs

SecurityBasic Authentication

Request

path Parameters

kafkaTopicId

required

string

ID of the Kafka topic

Request Body schema: application/json

required

Array of objects (KafkaTopicConfigV2)

list of Kafka topic configs

Responses

200

Requested Kafka topic configs update

put/cluster-management/v2/operations/applications/kafka/topics/v2/{kafkaTopicId}/modify-configs/v2

Request samples

application/json

{"configs": [{"key": "compression.type",
"value": "producer"
},
{"key": "leader.replication.throttled.replicas",
"value": ""
},
{"key": "message.downconversion.enable",
"value": "false"
},
{"key": "min.insync.replicas",
"value": "1"
},
{"key": "segment.jitter.ms",
"value": "0"
},
{"key": "cleanup.policy",
"value": "delete"
},
{"key": "flush.ms",
"value": "9223372036854775807"
},
{"key": "follower.replication.throttled.replicas",
"value": ""
},
{"key": "segment.bytes",
"value": "1073741824"
},
{"key": "retention.ms",
"value": "604800000"
},
{"key": "flush.messages",
"value": "9223372036854775807"
},
{"key": "message.format.version",
"value": "3.0-IV1"
},
{"key": "max.compaction.lag.ms",
"value": "9223372036854775807"
},
{"key": "file.delete.delay.ms",
"value": "60000"
},
{"key": "max.message.bytes",
"value": "1048588"
},
{"key": "min.compaction.lag.ms",
"value": "0"
},
{"key": "message.timestamp.type",
"value": "CreateTime"
},
{"key": "preallocate",
"value": "false"
},
{"key": "min.cleanable.dirty.ratio",
"value": "0.5"
},
{"key": "index.interval.bytes",
"value": "4096"
},
{"key": "unclean.leader.election.enable",
"value": "false"
},
{"key": "retention.bytes",
"value": "-1"
},
{"key": "delete.retention.ms",
"value": "86400000"
},
{"key": "segment.ms",
"value": "604800000"
},
{"key": "message.timestamp.difference.max.ms",
"value": "9223372036854775807"
},
{"key": "segment.index.bytes",
"value": "10485760"
}
]
}

Response samples

application/json

{"clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
"configs": [{"key": "compression.type",
"value": "producer"
},
{"key": "leader.replication.throttled.replicas",
"value": ""
},
{"key": "message.downconversion.enable",
"value": "false"
},
{"key": "min.insync.replicas",
"value": "1"
},
{"key": "segment.jitter.ms",
"value": "0"
},
{"key": "cleanup.policy",
"value": "delete"
},
{"key": "flush.ms",
"value": "9223372036854775807"
},
{"key": "follower.replication.throttled.replicas",
"value": ""
},
{"key": "segment.bytes",
"value": "1073741824"
},
{"key": "retention.ms",
"value": "604800000"
},
{"key": "flush.messages",
"value": "9223372036854775807"
},
{"key": "message.format.version",
"value": "3.0-IV1"
},
{"key": "max.compaction.lag.ms",
"value": "9223372036854775807"
},
{"key": "file.delete.delay.ms",
"value": "60000"
},
{"key": "max.message.bytes",
"value": "1048588"
},
{"key": "min.compaction.lag.ms",
"value": "0"
},
{"key": "message.timestamp.type",
"value": "CreateTime"
},
{"key": "preallocate",
"value": "false"
},
{"key": "min.cleanable.dirty.ratio",
"value": "0.5"
},
{"key": "index.interval.bytes",
"value": "4096"
},
{"key": "unclean.leader.election.enable",
"value": "false"
},
{"key": "retention.bytes",
"value": "-1"
},
{"key": "delete.retention.ms",
"value": "86400000"
},
{"key": "segment.ms",
"value": "604800000"
},
{"key": "message.timestamp.difference.max.ms",
"value": "9223372036854775807"
},
{"key": "segment.index.bytes",
"value": "10485760"
}
],
"partitions": 3,
"replicationFactor": 3,
"topic": "topic-test"
}

Create a Kafka Topic

SecurityBasic Authentication

Request

Request Body schema: application/json

partitions required	integer Topic partition count
replicationFactor required	integer Replication factor for Topic
topic required	string Kafka Topic name
clusterId required	string <uuid> ID of the Kafka cluster

Responses

202

Kafka topic provisioning requested

post/cluster-management/v2/resources/applications/kafka/topics/v2/

Request samples

application/json

{"clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
"configs": [{"key": "compression.type",
"value": "producer"
},
{"key": "leader.replication.throttled.replicas",
"value": ""
},
{"key": "message.downconversion.enable",
"value": "false"
},
{"key": "min.insync.replicas",
"value": "1"
},
{"key": "segment.jitter.ms",
"value": "0"
},
{"key": "cleanup.policy",
"value": "delete"
},
{"key": "flush.ms",
"value": "9223372036854775807"
},
{"key": "follower.replication.throttled.replicas",
"value": ""
},
{"key": "segment.bytes",
"value": "1073741824"
},
{"key": "retention.ms",
"value": "604800000"
},
{"key": "flush.messages",
"value": "9223372036854775807"
},
{"key": "message.format.version",
"value": "3.0-IV1"
},
{"key": "max.compaction.lag.ms",
"value": "9223372036854775807"
},
{"key": "file.delete.delay.ms",
"value": "60000"
},
{"key": "max.message.bytes",
"value": "1048588"
},
{"key": "min.compaction.lag.ms",
"value": "0"
},
{"key": "message.timestamp.type",
"value": "CreateTime"
},
{"key": "preallocate",
"value": "false"
},
{"key": "min.cleanable.dirty.ratio",
"value": "0.5"
},
{"key": "index.interval.bytes",
"value": "4096"
},
{"key": "unclean.leader.election.enable",
"value": "false"
},
{"key": "retention.bytes",
"value": "-1"
},
{"key": "delete.retention.ms",
"value": "86400000"
},
{"key": "segment.ms",
"value": "604800000"
},
{"key": "message.timestamp.difference.max.ms",
"value": "9223372036854775807"
},
{"key": "segment.index.bytes",
"value": "10485760"
}
],
"partitions": 3,
"replicationFactor": 3,
"topic": "topic-test"
}

Response samples

application/json

{"clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
"configs": [{"key": "compression.type",
"value": "producer"
},
{"key": "leader.replication.throttled.replicas",
"value": ""
},
{"key": "message.downconversion.enable",
"value": "false"
},
{"key": "min.insync.replicas",
"value": "1"
},
{"key": "segment.jitter.ms",
"value": "0"
},
{"key": "cleanup.policy",
"value": "delete"
},
{"key": "flush.ms",
"value": "9223372036854775807"
},
{"key": "follower.replication.throttled.replicas",
"value": ""
},
{"key": "segment.bytes",
"value": "1073741824"
},
{"key": "retention.ms",
"value": "604800000"
},
{"key": "flush.messages",
"value": "9223372036854775807"
},
{"key": "message.format.version",
"value": "3.0-IV1"
},
{"key": "max.compaction.lag.ms",
"value": "9223372036854775807"
},
{"key": "file.delete.delay.ms",
"value": "60000"
},
{"key": "max.message.bytes",
"value": "1048588"
},
{"key": "min.compaction.lag.ms",
"value": "0"
},
{"key": "message.timestamp.type",
"value": "CreateTime"
},
{"key": "preallocate",
"value": "false"
},
{"key": "min.cleanable.dirty.ratio",
"value": "0.5"
},
{"key": "index.interval.bytes",
"value": "4096"
},
{"key": "unclean.leader.election.enable",
"value": "false"
},
{"key": "retention.bytes",
"value": "-1"
},
{"key": "delete.retention.ms",
"value": "86400000"
},
{"key": "segment.ms",
"value": "604800000"
},
{"key": "message.timestamp.difference.max.ms",
"value": "9223372036854775807"
},
{"key": "segment.index.bytes",
"value": "10485760"
}
],
"partitions": 3,
"replicationFactor": 3,
"topic": "topic-test"
}

Get Kafka Topic details

SecurityBasic Authentication

Request

path Parameters

kafkaTopicId

required

string

Responses

200

Kafka topic details retrieved

get/cluster-management/v2/resources/applications/kafka/topics/v2/{kafkaTopicId}/

Request samples

Response samples

application/json

{"clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
"configs": [{"key": "compression.type",
"value": "producer"
},
{"key": "leader.replication.throttled.replicas",
"value": ""
},
{"key": "message.downconversion.enable",
"value": "false"
},
{"key": "min.insync.replicas",
"value": "1"
},
{"key": "segment.jitter.ms",
"value": "0"
},
{"key": "cleanup.policy",
"value": "delete"
},
{"key": "flush.ms",
"value": "9223372036854775807"
},
{"key": "follower.replication.throttled.replicas",
"value": ""
},
{"key": "segment.bytes",
"value": "1073741824"
},
{"key": "retention.ms",
"value": "604800000"
},
{"key": "flush.messages",
"value": "9223372036854775807"
},
{"key": "message.format.version",
"value": "3.0-IV1"
},
{"key": "max.compaction.lag.ms",
"value": "9223372036854775807"
},
{"key": "file.delete.delay.ms",
"value": "60000"
},
{"key": "max.message.bytes",
"value": "1048588"
},
{"key": "min.compaction.lag.ms",
"value": "0"
},
{"key": "message.timestamp.type",
"value": "CreateTime"
},
{"key": "preallocate",
"value": "false"
},
{"key": "min.cleanable.dirty.ratio",
"value": "0.5"
},
{"key": "index.interval.bytes",
"value": "4096"
},
{"key": "unclean.leader.election.enable",
"value": "false"
},
{"key": "retention.bytes",
"value": "-1"
},
{"key": "delete.retention.ms",
"value": "86400000"
},
{"key": "segment.ms",
"value": "604800000"
},
{"key": "message.timestamp.difference.max.ms",
"value": "9223372036854775807"
},
{"key": "segment.index.bytes",
"value": "10485760"
}
],
"partitions": 3,
"replicationFactor": 3,
"topic": "topic-test"
}

Delete the kafka topic

SecurityBasic Authentication

Request

path Parameters

kafkaTopicId

required

string

ID of the Kafka topic

Responses

204

Kafka topic delete requested

delete/cluster-management/v2/resources/applications/kafka/topics/v2/{kafkaTopicId}/

Request samples

➔ Next to Apache Kafka User V2