YugabyteDB Disaster Recovery API

openapi: 3.2.0
info:
  title: Yugabytedb Disaster Recovery API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Disaster Recovery across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-backups-restore.yaml, yugabytedb-anywhere-v1-full.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Disaster Recovery
paths:
  /api/v1/customers/{cUUID}/dr_configs:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigCreateForm'
        description: Disaster Recovery Create Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_create_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: deleteXClusterConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: isForceDelete
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete xcluster config
      tags:
      - Disaster Recovery
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: syncWithDB
        schema:
          default: true
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DrConfigGetResp'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get disaster recovery config
      tags:
      - Disaster Recovery
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/edit:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: editDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigEditForm'
        description: Disaster Recovery Edit Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Edit disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_edit_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/failover:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: failoverDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigFailoverForm'
        description: Disaster Recovery Failover Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Failover a disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_failover_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: pauseDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Pause DR config
      tags:
      - Disaster Recovery
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause_universes:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: pauseDrUniverses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Pause DR config and universes associated with DR
      tags:
      - Disaster Recovery
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replica:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: replaceReplicaDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigReplaceReplicaForm'
        description: Disaster Recovery Replace Replica Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Replace Replica in a disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_replace_replica_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/restart:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: restartDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: isForceDelete
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigRestartForm'
        description: Disaster Recovery Restart Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Restart disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_restart_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: resumeDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Resume DR config
      tags:
      - Disaster Recovery
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume_universes:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: resumeDrUniverses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Resume DR config and universes associated with DR
      tags:
      - Disaster Recovery
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetime:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getDrConfigSafetime
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DrConfigSafetimeResp'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get disaster recovery config safetime
      tags:
      - Disaster Recovery
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs:
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: setDatabasesDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigSetDatabasesForm'
        description: Disaster Recovery Set Databases Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set databases in disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_set_databases_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tables:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: setTablesDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigSetTablesForm'
        description: Disaster Recovery Set Tables Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set tables in disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_set_tables_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchover:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: switchoverDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigSwitchoverForm'
        description: Disaster Recovery Switchover Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Switchover a disaster recovery config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_switchover_form_data
    servers:
    - url: /
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/sync:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: syncDrConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Sync disaster recovery config
      tags:
      - Disaster Recovery
    servers:
    - url: /
components:
  schemas:
    NamespaceSafetime:
      example:
        namespaceId: namespaceId
        safetimeLagUs: 1
        estimatedDataLossMs: 0.8008281904610115
        safetimeEpochUs: 6
        namespaceName: namespaceName
        safetimeSkewUs: 5
      properties:
        estimatedDataLossMs:
          format: double
          type: number
        namespaceId:
          type: string
        namespaceName:
          type: string
        safetimeEpochUs:
          format: int64
          type: integer
        safetimeLagUs:
          format: int64
          type: integer
        safetimeSkewUs:
          format: int64
          type: integer
      required:
      - estimatedDataLossMs
      - namespaceId
      - namespaceName
      - safetimeEpochUs
      - safetimeLagUs
      - safetimeSkewUs
      type: object
    BootstrapBackupParams:
      description: Backup parameters for bootstrapping
      example:
        storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        parallelism: 0
      properties:
        parallelism:
          description: Number of concurrent commands used by yb_backup (not ybc) to run on nodes over SSH
          format: int32
          type: integer
        storageConfigUUID:
          description: Storage configuration UUID
          format: uuid
          type: string
      required:
      - storageConfigUUID
      type: object
    DrConfigSetTablesForm:
      description: dr config set tables form
      example:
        tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
        bootstrapParams:
          backupRequestParams:
            storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            parallelism: 0
        autoIncludeIndexTables: true
      properties:
        autoIncludeIndexTables:
          description: Whether or not YBA should also include all index tables from any provided main tables.
          type: boolean
        bootstrapParams:
          $ref: '#/components/schemas/RestartBootstrapParams'
        tables:
          description: Source universe table IDs
          example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]'
          items:
            type: string
          type: array
          uniqueItems: true
      type: object
    DrConfigReplaceReplicaForm:
      description: drConfig edit form
      example:
        bootstrapParams:
          backupRequestParams:
            storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            parallelism: 0
        drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        bootstrapParams:
          $ref: '#/components/schemas/RestartBootstrapParams'
        drReplicaUniverseUuid:
          description: New dr replica universe UUID
          format: uuid
          type: string
        primaryUniverseUuid:
          description: The current primary universe UUID
          format: uuid
          type: string
      type: object
    DrConfigGetResp:
      description: disaster recovery get response
      example:
        paused: true
        replicationGroupName: replicationGroupName
        bootstrapParams:
          backupRequestParams:
            storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            parallelism: 0
        xclusterConfigUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        drReplicaUniverseState: Unconfigured for DR
        type: Basic
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        xclusterConfigsUuid:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        tableType: UNKNOWN
        tables:
        - tables
        - tables
        modifyTime: 2022-12-12 13:07:18+00:00
        primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        drReplicaUniverseActive: true
        state: Initializing
        primaryUniverseState: Unconfigured for DR
        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
        dbDetails:
        - 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
        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
        primaryUniverseActive: true
        automaticDdlMode: true
        dbs:
        - dbs
        - dbs
        createTime: 2022-12-12 13:07:18+00:00
        webhooks:
        - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          url: url
        - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          url: url
        name: name
        drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        keyspacePending: keyspacePending
        pitrRetentionPeriodSec: 2
        pitrSnapshotIntervalSec: 7
        status: Initialized
      properties:
        automaticDdlMode:
          description: Whether the config is using automatic DDL replication mode.
          type: boolean
        bootstrapParams:
          $ref: '#/components/schemas/RestartBootstrapParams'
        createTime:
          description: Create time of the DR config
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        dbDetails:
          description: 'WARNING: This is a preview API that could change. List of db details in replication'
          items:
            $ref: '#/components/schemas/XClusterNamespaceConfig'
          type: array
          uniqueItems: true
        dbs:
          description: 'WARNING: This is a preview API that could change. List of db ids in replication'
          items:
            type: string
          type: array
          uniqueItems: true
        drReplicaUniverseActive:
          description: Whether the dr replica universe is active
          type: boolean
        drReplicaUniverseState:
          description: 'WARNING: This is a preview API that could change. The replication status of the dr replica universe.'
          enum:
          - Unconfigured for DR
          - Bootstrapping
          - Receiving data, Ready for reads
          - Switching to DR primary
          - Universe marked as DR failed
          type: string
        drReplicaUniverseUuid:
          description: DR Replica Universe UUID
          format: uuid
          type: string
        keyspacePending:
          description: 'WARNING: This is a preview API that could change. The keyspace name that the current task is working on.'
          type: string
        modifyTime:
          description: Last modify time of the DR config
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        name:
          description: Disaster recovery config name
          type: string
        paused:
          description: Whether the underlying xCluster config is paused
          type: boolean
        pitrConfigs:
          description: 'WARNING: This is a preview API that could change. The list of PITR configs used for the underlying txn xCluster config'
          items:
            $ref: '#/components/schemas/PitrConfig'
          type: array
        pitrRetentionPeriodSec:
          description: 'WARNING: This is a preview API that could change. PITR Retention Period in seconds'
          format: int64
          type: integer
        pitrSnapshotIntervalSec:
          description: 'WARNING: This is a preview API that could change. PITR Retention Period in seconds'
          format: int64
          type: integer
        primaryUniverseActive:
          description: Whether the primary universe is active
          type: boolean
        primaryUniverseState:
          description: 'WARNING: This is a preview API that could change. The replication status of the primary universe.'
          enum:
          - Unconfigured for DR
          - Ready to replicate
          - Waiting for DR
          - Replicating data
          - Preparing for switchover
          - Switching to DR replica
          - Universe marked as DR failed
          type: string
        primaryUniverseUuid:
          description: Primary Universe UUID
          format: uuid
          type: string
        replicationGroupName:
          description: Replication group name in the dr replica universe cluster config
          type: string
        state:
          description: The state of the DR config
          enum:
          - Initializing
          - Replicating
          - Switchover in Progress
          - Failover in Progress
          - Halted
          - Updating
          - Failed
          type: string
        status:
          description: Status
          enum:
          - Initialized
          - Running
          - Updating
          - DeletedUniverse
          - DeletionFailed
          - Failed
          type: string
        tableDetails:
          description: Details for each table in replication
          items:
            $ref: '#/components/schemas/XClusterTableConfig'
          type: array
          uniqueItems: true
        tableType:
          description: The type of tables that are being replicated
          enum:
          - UNKNOWN
          - YSQL
          - YCQL
          type: string
        tables:
          description: List of table ids in replication
          items:
            type: string
          type: array
          uniqueItems: true
        type:
          description: Whether the config is basic, txn, or db scoped xCluster
          enum:
          - Basic
          - Txn
          - Db
          type: string
        uuid:
          description: DR config UUID
          format: uuid
          type: string
        webhooks:
          items:
            $ref: '#/components/schemas/GetWebhookResponse'
          type: array
        xclusterConfigUuid:
          desc

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