YugabyteDB Asynchronous Replication API

openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Asynchronous Replication API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
tags:
- name: Asynchronous Replication
paths:
  /api/v1/customers/{cUUID}/universes/{uniUUID}/need_bootstrap:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: needBootstrapTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: configType
        schema:
          default: 'null'
          type: string
        example: 'null'
      - in: query
        name: includeDetails
        schema:
          default: false
          type: boolean
        example: false
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XClusterConfigNeedBootstrapFormData'
            examples:
              NeedBootstrapTableRequestExample:
                summary: Default needBootstrapTable request
                x-microcks-default: true
                value:
                  targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  isDrConfig: true
                  tables: '["000033df00003000800000000000400b"]'
        description: XCluster Need Bootstrap Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
              examples:
                NeedBootstrapTable200Example:
                  summary: Default needBootstrapTable 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Whether Tables Need Bootstrap Before Setting Up Cross Cluster Replication
      tags:
      - Asynchronous Replication
      x-codegen-request-body-name: xcluster_need_bootstrap_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/xcluster_configs:
    post:
      description: Available since YBA version 2.16.0.0.
      operationId: createXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XClusterConfigCreateFormData'
            examples:
              CreateXClusterConfigRequestExample:
                summary: Default createXClusterConfig request
                x-microcks-default: true
                value:
                  targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
                  dryRun: true
                  bootstrapParams:
                    tables: '["000033df000030008000000000004006"]'
                    allowBootstrap: true
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
                  name: Repl-config1
                  sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  configType: Basic
        description: XCluster Replication Create Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                CreateXClusterConfig200Example:
                  summary: Default createXClusterConfig 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Create Xcluster Config
      tags:
      - Asynchronous Replication
      x-codegen-request-body-name: xcluster_replication_create_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/xcluster_configs/sync:
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.23.0.0.</b></p> Sync xcluster config (V2) instead.
      operationId: syncXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: targetUniverseUUID
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                SyncXClusterConfig200Example:
                  summary: Default syncXClusterConfig 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Sync Xcluster Config - Deprecated
      tags:
      - Asynchronous Replication
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}:
    delete:
      description: Available since YBA version 2.16.0.0.
      operationId: deleteXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: xccUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: isForceDelete
        schema:
          default: false
          type: boolean
        example: false
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                DeleteXClusterConfig200Example:
                  summary: Default deleteXClusterConfig 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete Xcluster Config
      tags:
      - Asynchronous Replication
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Available since YBA version 2.16.0.0.
      operationId: getXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: xccUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: syncWithDB
        schema:
          default: true
          type: boolean
        example: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XClusterConfigGetResp'
              examples:
                GetXClusterConfig200Example:
                  summary: Default getXClusterConfig 200 response
                  x-microcks-default: true
                  value:
                    paused: true
                    replicationGroupName: replicationGroupName
                    targetUniverseState: Unconfigured for DR
                    type: Basic
                    usedForDr: true
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    tableType: UNKNOWN
                    tables:
                    - tables
                    - tables
                    lag: '{}'
                    modifyTime: 2022-12-12 13:07:18+00:00
                    targetActive: true
                    imported: true
                    namespaceDetails:
                    - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      sourceNamespaceId: sourceNamespaceId
                      backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      replicationSetupTime: 2022-12-12 13:07:18+00:00
                      sourceNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      targetNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      status: Validated
                    - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      sourceNamespaceId: sourceNamespaceId
                      backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      replicationSetupTime: 2022-12-12 13:07:18+00:00
                      sourceNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      targetNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      status: Validated
                    tableDetails:
                    - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      streamId: a9d2470786694dc4b34e0e58e592da9e
                      backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      replicationStatusErrors:
                      - Unknown error
                      - Unknown error
                      sourceTableInfo:
                        relationType: SYSTEM_TABLE_RELATION
                        colocated: true
                        walSizeBytes: 3.616076749251911
                        indexTableIDs:
                        - indexTableIDs
                        - indexTableIDs
                        pgSchemaName: public
                        sizeBytes: 9.301444243932576
                        tableName: tableName
                        tableSpace: tableSpace
                        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        tableType: YQL_TABLE_TYPE
                        keySpace: keySpace
                        tableID: tableID
                        nameSpace: nameSpace
                        colocationParentId: colocationParentId
                      replicationSetupDone: true
                      restoreTime: 2022-12-12 13:07:18+00:00
                      bootstrapCreateTime: 2022-12-12 13:07:18+00:00
                      indexTable: true
                      tableId: 000033df000030008000000000004005
                      targetTableInfo:
                        relationType: SYSTEM_TABLE_RELATION
                        colocated: true
                        walSizeBytes: 3.616076749251911
                        indexTableIDs:
                        - indexTableIDs
                        - indexTableIDs
                        pgSchemaName: public
                        sizeBytes: 9.301444243932576
                        tableName: tableName
                        tableSpace: tableSpace
                        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        tableType: YQL_TABLE_TYPE
                        keySpace: keySpace
                        tableID: tableID
                        nameSpace: nameSpace
                        colocationParentId: colocationParentId
                      needBootstrap: true
                      status: Validated
                    - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      streamId: a9d2470786694dc4b34e0e58e592da9e
                      backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      replicationStatusErrors:
                      - Unknown error
                      - Unknown error
                      sourceTableInfo:
                        relationType: SYSTEM_TABLE_RELATION
                        colocated: true
                        walSizeBytes: 3.616076749251911
                        indexTableIDs:
                        - indexTableIDs
                        - indexTableIDs
                        pgSchemaName: public
                        sizeBytes: 9.301444243932576
                        tableName: tableName
                        tableSpace: tableSpace
                        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        tableType: YQL_TABLE_TYPE
                        keySpace: keySpace
                        tableID: tableID
                        nameSpace: nameSpace
                        colocationParentId: colocationParentId
                      replicationSetupDone: true
                      restoreTime: 2022-12-12 13:07:18+00:00
                      bootstrapCreateTime: 2022-12-12 13:07:18+00:00
                      indexTable: true
                      tableId: 000033df000030008000000000004005
                      targetTableInfo:
                        relationType: SYSTEM_TABLE_RELATION
                        colocated: true
                        walSizeBytes: 3.616076749251911
                        indexTableIDs:
                        - indexTableIDs
                        - indexTableIDs
                        pgSchemaName: public
                        sizeBytes: 9.301444243932576
                        tableName: tableName
                        tableSpace: tableSpace
                        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        tableType: YQL_TABLE_TYPE
                        keySpace: keySpace
                        tableID: tableID
                        nameSpace: nameSpace
                        colocationParentId: colocationParentId
                      needBootstrap: true
                      status: Validated
                    targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    pitrConfigs:
                    - dbName: dbName
                      updateTime: 2022-12-12 13:07:18+00:00
                      createdForDr: true
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      minRecoverTimeInMillis: 1
                      scheduleInterval: 5
                      tableType: YQL_TABLE_TYPE
                      customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      createTime: 2022-12-12 13:07:18+00:00
                      intermittentMinRecoverTimeInMillis: 0
                      maxRecoverTimeInMillis: 6
                      name: name
                      disabled: true
                      usedForXCluster: true
                      state: UNKNOWN
                      retentionPeriod: 5
                    - dbName: dbName
                      updateTime: 2022-12-12 13:07:18+00:00
                      createdForDr: true
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      minRecoverTimeInMillis: 1
                      scheduleInterval: 5
                      tableType: YQL_TABLE_TYPE
                      customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      createTime: 2022-12-12 13:07:18+00:00
                      intermittentMinRecoverTimeInMillis: 0
                      maxRecoverTimeInMillis: 6
                      name: name
                      disabled: true
                      usedForXCluster: true
                      state: UNKNOWN
                      retentionPeriod: 5
                    secondary: true
                    automaticDdlMode: true
                    dbs:
                    - dbs
                    - dbs
                    createTime: 2022-12-12 13:07:18+00:00
                    name: name
                    sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    keyspacePending: keyspacePending
                    sourceActive: true
                    namespaces:
                    - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      sourceNamespaceId: sourceNamespaceId
                      backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      replicationSetupTime: 2022-12-12 13:07:18+00:00
                      sourceNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      targetNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      status: Validated
                    - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      sourceNamespaceId: sourceNamespaceId
                      backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      replicationSetupTime: 2022-12-12 13:07:18+00:00
                      sourceNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      targetNamespaceInfo:
                        tableType: YQL_TABLE_TYPE
                        name: name
                        namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      status: Validated
                    sourceUniverseState: Unconfigured for DR
                    status: Initialized
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Xcluster Config
      tags:
      - Asynchronous Replication
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      description: Available since YBA version 2.16.0.0.
      operationId: restartXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: xccUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: isForceDelete
        schema:
          default: false
          type: boolean
        example: false
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XClusterConfigRestartFormData'
            examples:
              RestartXClusterConfigRequestExample:
                summary: Default restartXClusterConfig request
                x-microcks-default: true
                value:
                  tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
                  dryRun: true
                  bootstrapParams:
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
        description: XCluster Replication Restart Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                RestartXClusterConfig200Example:
                  summary: Default restartXClusterConfig 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Restart Xcluster Config
      tags:
      - Asynchronous Replication
      x-codegen-request-body-name: xcluster_replication_restart_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      description: Available since YBA version 2.16.0.0.
      operationId: editXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: xccUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XClusterConfigEditFormData'
            examples:
              EditXClusterConfigRequestExample:
                summary: Default editXClusterConfig request
                x-microcks-default: true
                value:
                  tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
                  dryRun: true
                  bootstrapParams:
                    tables: '["000033df000030008000000000004006"]'
                    allowBootstrap: true
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
                  dbs: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
                  autoIncludeIndexTables: true
                  targetRole: ACTIVE
                  name: Repl-config1
                  sourceRole: ACTIVE
                  status: Running
        description: XCluster Replication Edit Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                EditXClusterConfig200Example:
                  summary: Default editXClusterConfig 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Edit Xcluster Config
      tags:
      - Asynchronous Replication
      x-codegen-request-body-name: xcluster_replication_edit_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/need_bootstrap:
    post:
      description: YbaApi Internal.
      operationId: NeedBootstrapXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: xccUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XClusterConfigNeedBootstrapFormData'
            examples:
              NeedBootstrapXClusterConfigRequestExample:
                summary: Default NeedBootstrapXClusterConfig request
                x-microcks-default: true
                value:
                  targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  isDrConfig: true
                  tables: '["000033df00003000800000000000400b"]'
        description: XCluster Need Bootstrap Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
              examples:
                NeedBootstrapXClusterConfig200Example:
                  summary: Default NeedBootstrapXClusterConfig 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Whether Tables in an XCluster Replication Config Have Fallen Far Behind and Need Bootstrap
      tags:
      - Asynchronous Replication
      x-codegen-request-body-name: xcluster_need_bootstrap_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/sync:
    post:
      description: Available since YBA version 2.23.0.0
      operationId: syncXClusterConfigV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: xccUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                SyncXClusterConfigV2200Example:
                  summary: Default syncXClusterConfigV2 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Sync Xcluster Config (V2)
      tags:
      - Asynchronous Replication
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    XClusterConfigEditFormData:
      description: xcluster edit form
      example:
        tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
        dryRun: true
        bootstrapParams:
          tables: '["000033df000030008000000000004006"]'
          allowBootstrap: true
          backupRequestParams:
            storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            parallelism: 0
        dbs: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
        autoIncludeIndexTables: true
        targetRole: ACTIVE
        name: Repl-config1
        sourceRole: ACTIVE
        status: Running
      properties:
        autoIncludeIndexTables:
          description: Whether or not YBA should also include all index tables from any provided main tables.
          type: boolean
          example: true
        bootstrapParams:
          $ref: '#/components/schemas/BootstrapParams'
        dbs:
          description: 'WARNING: This is a preview API that could change. Source universe database IDs'
          example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
          items:
            type: string
          type: array
          uniqueItems: true
        dryRun:
          description: Run the pre-checks without actually running the subtasks
          type: boolean
          example: true
        name:
          description: Name
          example: Repl-config1
          type: string
        sourceRole:
          description: The role that the source universe should have in the xCluster config
          enum:
          - ACTIVE
          - STANDBY
          - UNRECOGNIZED
          type: string
          example: ACTIVE
        status:
          description: Status
          enum:
          - Running
          - Paused
          type: string
          example: Running
        tables:
          description: Source universe table IDs
          example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
          items:
            type: string
          type: array
          uniqueItems: true
        targetRole:
          description: The role that the target universe should have in the xCluster config
          enum:
          - ACTIVE
          - STANDBY
          - UNRECOGNIZED
          type: string
          example: ACTIVE
      type: object
    TableInfoResp:
      description: Table information response
      example:
        relationType: SYSTEM_TABLE_RELATION
        colocated: true
        walSizeBytes: 3.616076749251911
        indexTableIDs:
        - indexTableIDs
        - indexTableIDs
        pgSchemaName: public
        sizeBytes: 9.301444243932576
        tableName: tableName
        tableSpace: tableSpace
        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        tableType: YQL_TABLE_TYPE
        keySpace: keySpace
        tableID: tableID
        nameSpace: nameSpace
        colocationParentId: colocationParentId
      properties:
        colocated:
          description: Flag, indicating colocated table
          type: boolean
          example: true
        colocationParentId:
          descript

# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-asynchronous-replication-api-openapi.yml