Responses

• 200 application/json

  OK

  One of:

  outbound_migration_state object inbound_migration_state object

  Hide attributes Show attributes

  • id integer(int32)

    Unique identifier of migration

  • state string
  • migration object
    Hide migration attributes Show migration attributes object

    • 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.

  Hide attributes Show attributes

  • id integer(int32)

    Unique identifier of migration

  • state string
  • migration object
    Hide migration attributes Show migration attributes object

    • 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.