Create migration

PUT /v1/migrations

application/json

Body object Required

Migration configuration

migration_type string Required Discriminator

Value is inbound.
topics array[object]
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.
consumer_groups array[string]

List of migrated consumer groups
auto_advance boolean

If set, you do not need to take manual action for the migration to progress.

migration_type string Discriminator

Value is outbound.
topics array[object]

List of migrated topics

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 topics attributes Show topics 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.
consumer_groups array[string]

List of migrated consumer groups
copy_to object
Hide copy_to attributes Show copy_to attributes object
- access_key string
- secret_key string
- region string
- bucket string Required
- credential_source string
  
  Values are config, instance_metadata, or sts.
- topic_manifest_prefix string
  
  Path where topic manifests are copied to
auto_advance boolean

If set, you do not need to take manual action for the migration to progress.

Responses

200 application/json

OK
One of:
inbound_migration object outbound_migration object
Hide attributes Show attributes

migration_type string Required

Value is inbound.

topics array[object]

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.

consumer_groups array[string]

List of migrated consumer groups

auto_advance boolean

If set, you do not need to take manual action for the migration to progress.
Hide attributes Show attributes

migration_type string

Value is outbound.

topics array[object]

List of migrated topics

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 topics attributes Show topics 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.

consumer_groups array[string]

List of migrated consumer groups

copy_to object

Hide copy_to attributes Show copy_to attributes object

access_key string

secret_key string

region string

bucket string Required

credential_source string

Values are config, instance_metadata, or sts.

topic_manifest_prefix string

Path where topic manifests are copied to

auto_advance boolean

If set, you do not need to take manual action for the migration to progress.

PUT /v1/migrations

curl \
 --request PUT 'http://localhost:9644/v1/migrations' \
 --header "Content-Type: application/json" \
 --data '{"migration_type":"inbound","topics":[{"source_topic_reference":{"topic":"string","ns":"string"},"alias":{"topic":"string","ns":"string"}}],"consumer_groups":["string"],"auto_advance":true}'

Request examples

{
  "migration_type": "inbound",
  "topics": [
    {
      "source_topic_reference": {
        "topic": "string",
        "ns": "string"
      },
      "alias": {
        "topic": "string",
        "ns": "string"
      }
    }
  ],
  "consumer_groups": [
    "string"
  ],
  "auto_advance": true
}

{
  "migration_type": "outbound",
  "topics": [
    {
      "topic": "string",
      "ns": "string"
    }
  ],
  "consumer_groups": [
    "string"
  ],
  "copy_to": {
    "access_key": "string",
    "secret_key": "string",
    "region": "string",
    "bucket": "string",
    "credential_source": "config",
    "topic_manifest_prefix": "string"
  },
  "auto_advance": true
}

Response examples (200)

{
  "migration_type": "inbound",
  "topics": [
    {
      "source_topic_reference": {
        "topic": "string",
        "ns": "string"
      },
      "alias": {
        "topic": "string",
        "ns": "string"
      }
    }
  ],
  "consumer_groups": [
    "string"
  ],
  "auto_advance": true
}

{
  "migration_type": "outbound",
  "topics": [
    {
      "topic": "string",
      "ns": "string"
    }
  ],
  "consumer_groups": [
    "string"
  ],
  "copy_to": {
    "access_key": "string",
    "secret_key": "string",
    "region": "string",
    "bucket": "string",
    "credential_source": "config",
    "topic_manifest_prefix": "string"
  },
  "auto_advance": true
}