YugabyteDB Disaster Recovery API

The Disaster Recovery API from YugabyteDB — 15 operation(s) for disaster recovery.

Documentation

Specifications

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

OpenAPI Specification

yugabytedb-disaster-recovery-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Disaster Recovery 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: 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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DrConfigCreateForm'
            examples:
              CreateDrConfigRequestExample:
                summary: Default createDrConfig request
                x-microcks-default: true
                value:
                  targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  dryRun: true
                  bootstrapParams:
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
                  dbs: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]'
                  name: Dr-config1
                  sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  pitrParams:
                    snapshotIntervalSec: 1
                    retentionPeriodSec: 6
        description: Disaster Recovery Create Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                CreateDrConfig200Example:
                  summary: Default createDrConfig 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 Disaster Recovery Config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_create_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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/DrConfigGetResp'
              examples:
                GetDrConfig200Example:
                  summary: Default getDrConfig 200 response
                  x-microcks-default: true
                  value:
                    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
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Disaster Recovery Config
      tags:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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/DrConfigEditForm'
            examples:
              EditDrConfigRequestExample:
                summary: Default editDrConfig request
                x-microcks-default: true
                value:
                  bootstrapParams:
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
                  webhookUrls:
                  - webhookUrls
                  - webhookUrls
                  pitrParams:
                    snapshotIntervalSec: 1
                    retentionPeriodSec: 6
        description: Disaster Recovery Edit Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                EditDrConfig200Example:
                  summary: Default editDrConfig 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 Disaster Recovery Config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_edit_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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/DrConfigFailoverForm'
            examples:
              FailoverDrConfigRequestExample:
                summary: Default failoverDrConfig request
                x-microcks-default: true
                value:
                  namespaceIdSafetimeEpochUsMap:
                    key: 0
                  drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        description: Disaster Recovery Failover Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                FailoverDrConfig200Example:
                  summary: Default failoverDrConfig 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 Failover a Disaster Recovery Config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_failover_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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:
                PauseDrConfig200Example:
                  summary: Default pauseDrConfig 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 Pause DR Config
      tags:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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:
                PauseDrUniverses200Example:
                  summary: Default pauseDrUniverses 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 Pause DR Config and Universes Associated with DR
      tags:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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/DrConfigReplaceReplicaForm'
            examples:
              ReplaceReplicaDrConfigRequestExample:
                summary: Default replaceReplicaDrConfig request
                x-microcks-default: true
                value:
                  bootstrapParams:
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
                  drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        description: Disaster Recovery Replace Replica Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                ReplaceReplicaDrConfig200Example:
                  summary: Default replaceReplicaDrConfig 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 Replace Replica in a Disaster Recovery Config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_replace_replica_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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/DrConfigRestartForm'
            examples:
              RestartDrConfigRequestExample:
                summary: Default restartDrConfig request
                x-microcks-default: true
                value:
                  bootstrapParams:
                    backupRequestParams:
                      storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      parallelism: 0
                  dbs: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]'
        description: Disaster Recovery Restart Form Data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                RestartDrConfig200Example:
                  summary: Default restartDrConfig 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 Disaster Recovery Config
      tags:
      - Disaster Recovery
      x-codegen-request-body-name: disaster_recovery_restart_form_data
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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:
                ResumeDrConfig200Example:
                  summary: Default resumeDrConfig 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 Resume DR Config
      tags:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        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:
                ResumeDrUniverses200Example:
                  summary: Default resumeDrUniverses 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 Resume DR Config and Universes Associated with DR
      tags:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: drUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DrConfigSafetimeResp'
              examples:
                GetDrConfigSafetime200Example:
                  summary: Default getDrConfigSafetime 200 response
                  x-microcks-default: true
                  value:
                    safetimes:
                    - namespaceId: namespaceId
                      safetimeLagUs: 1
                      estimatedDataLossMs: 0.8008281904610115
                      safetimeEpochUs: 6
                      namespaceName: namespaceName
                      safetimeSkewUs: 5
                    - namespaceId: namespaceId
                      safetimeLagUs: 1
                      estimatedDataLossMs: 0.8008281904610115
                      safetimeEpochUs: 6
                      namespaceName: namespaceName
                      safetimeSkewUs: 5
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Disaster Recovery Config Safetime
      tags:
      - Disaster Recovery
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs:
    put:
      

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