Skip to main content
POST
/
topics
Create a new Kafka topic
curl --request POST \
  --url https://api.streamkap.com/topics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topic_name": "<string>",
  "num_partitions": 1,
  "replication_factor": 2,
  "cleanup_policy": "delete",
  "min_insync_replicas": 2,
  "retention_ms": 0,
  "retention_bytes": 0,
  "max_message_bytes": 2,
  "custom_configs": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "entity": {
    "entity_type": "sources",
    "entity_id": "<string>",
    "name": "<string>",
    "connector": "elasticsearch",
    "topic_ids": [
      "<string>"
    ],
    "topic_db_ids": [
      "<string>"
    ],
    "display_name": "<string>"
  },
  "num_partitions": 123,
  "replication_factor": 123,
  "prefix": "<string>",
  "serialization": {
    "key_format": "unknown",
    "value_format": "unknown",
    "key_converter": "<string>",
    "value_converter": "<string>",
    "schema_registry_enabled": false
  },
  "warnings": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
topic_name
string
required

Kafka topic name

Required string length: 1 - 249
​
num_partitions
integer
default:1

Number of partitions

Required range: x >= 1
​
replication_factor
integer | null

Replication factor (defaults to broker count)

Required range: x >= 1
​
cleanup_policy
enum<string> | null

Topic cleanup policy

Available options:
delete,
compact,
delete,compact
​
min_insync_replicas
integer | null

Minimum in-sync replicas

Required range: x >= 1
​
retention_ms
integer | null

Time to retain data in ms (-1 for unlimited)

Required range: x >= -1
​
retention_bytes
integer | null

Max size on disk in bytes (-1 for unlimited)

Required range: x >= -1
​
max_message_bytes
integer | null

Maximum message size in bytes

Required range: x >= 1
​
custom_configs
Custom Configs · object

Additional topic configs as key-value pairs

Response

Successful Response

​
id
string
required
​
name
string
required
​
entity
TopicDetailsEntity · object
required
​
num_partitions
integer
required
​
replication_factor
integer
required
​
prefix
string | null
​
serialization
TopicSerialization · object

Serialization format information for a topic.

Topics inherit their serialization format from their producer (source/transform). Most Streamkap sources use Avro by default with Schema Registry.

​
warnings
CreateTopicWarning · object[]