Mount a topic to a cluster

POST /v1/topics/mount

Mount a topic in object storage to a cluster according to the specified configuration.

application/json

Body Required

Mount topic configuration

topics array[object] Required

List of topics to mount
Hide topics attributes Show topics attributes object
- source_topic_reference object
  
  Name of topic in object storage. To uniquely identify the topic, append the name with /<cluster-uuid>/<initial-revision>. Redpanda assigns the numberinitial-revision` to a topic upon creation.
  Hide source_topic_reference attributes Show source_topic_reference attributes object
  
  topic string Required
  
  Topic name
  
  ns string
  
  Topic namespace. If not present, it is assumed that the topic is in the kafka namespace.
- alias object
  
  Name of topic in object storage. To uniquely identify the topic, append the name with /<cluster-uuid>/<initial-revision>. Redpanda assigns the numberinitial-revision` to a topic upon creation.
  Hide alias attributes Show alias attributes object
  
  topic string Required
  
  Topic name
  
  ns string
  
  Topic namespace. If not present, it is assumed that the topic is in the kafka namespace.

Responses

200 application/json

Underlying migration information
Hide response attribute Show response attribute object
- id integer(int32)

POST /v1/topics/mount

curl \
 --request POST 'http://localhost:9644/v1/topics/mount' \
 --header "Content-Type: application/json" \
 --data '{"topics":[{"source_topic_reference":{"topic":"string","ns":"string"},"alias":{"topic":"string","ns":"string"}}]}'

Request examples

{
  "topics": [
    {
      "source_topic_reference": {
        "topic": "string",
        "ns": "string"
      },
      "alias": {
        "topic": "string",
        "ns": "string"
      }
    }
  ]
}

Response examples (200)

{
  "id": 42
}