# YugabyteDB Disaster Recovery API

**Canonical:** https://apis.io/apis/yugabyte/yugabytedb-disaster-recovery-api/  
**Provider:** Yugabyte — https://apis.io/providers/yugabyte/  
**Base URL:** https://cloud.yugabyte.com/api/public/v1  
**Documentation:** https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/

YugabyteDB Disaster Recovery API is one of 82 APIs that [Yugabyte](https://apis.io/providers/yugabyte/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Disaster Recovery. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

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

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/customers/{cUUID}/dr_configs` | Create disaster recovery config |
| DELETE | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}` | Delete xcluster config |
| GET | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}` | Get disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/edit` | Edit disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/failover` | Failover a disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause` | Pause DR config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause_universes` | Pause DR config and universes associated with DR |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replica` | Replace Replica in a disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/restart` | Restart disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume` | Resume DR config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume_universes` | Resume DR config and universes associated with DR |
| GET | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetime` | Get disaster recovery config safetime |
| PUT | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs` | Set databases in disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tables` | Set tables in disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchover` | Switchover a disaster recovery config |
| POST | `/api/v1/customers/{cUUID}/dr_configs/{drUUID}/sync` | Sync disaster recovery config |

## Machine-readable artifacts (27)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-disaster-recovery-api-openapi.yml
- **Documentation** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
- **APIReference** — https://api-docs.yugabyte.com/docs/managed-apis/
- **GettingStarted** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
- **Authentication** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
- **CLI** — https://github.com/yugabyte/ybm-cli
- **Integrations** — https://github.com/yugabyte/terraform-provider-ybm
- **TermsOfService** — https://www.yugabyte.com/yugabytedb-managed-service-terms/
- **Documentation** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **APIReference** — https://api-docs.yugabyte.com/docs/yugabyte-platform/
- **GettingStarted** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **Authentication** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **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/yugabyte/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-restore-job.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-storage-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-dr-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-pitr-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-release.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-support-bundle.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybprovider.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybplatform.yaml

## Other Yugabyte APIs (12)

- [YugabyteDB Aeon REST API](https://apis.io/apis/yugabyte/yugabytedb-aeon-rest-api/)
- [Yugabyte Backup Info API](https://apis.io/apis/yugabyte/yugabyte-backup-info-api/)
- [Yugabyte Cluster API](https://apis.io/apis/yugabyte/yugabyte-cluster-api/)
- [Yugabyte Cluster Info API](https://apis.io/apis/yugabyte/yugabyte-cluster-info-api/)
- [Yugabyte Pitr Info API](https://apis.io/apis/yugabyte/yugabyte-pitr-info-api/)
- [Yugabyte Restore Info API](https://apis.io/apis/yugabyte/yugabyte-restore-info-api/)
- [Yugabyte Voyager Info API](https://apis.io/apis/yugabyte/yugabyte-voyager-info-api/)
- [Yugabyte Voyager Metrics API](https://apis.io/apis/yugabyte/yugabyte-voyager-metrics-api/)
- [Yugabyte Xcluster Metrics API](https://apis.io/apis/yugabyte/yugabyte-xcluster-metrics-api/)
- [Yugabyte Xcluster Namespace Details API](https://apis.io/apis/yugabyte/yugabyte-xcluster-namespace-details-api/)
- [YugabyteDB Access Keys API](https://apis.io/apis/yugabyte/yugabytedb-access-keys-api/)
- [YugabyteDB Accounts API](https://apis.io/apis/yugabyte/yugabytedb-accounts-api/)

## Tags

Disaster Recovery

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yugabyte/yugabytedb-disaster-recovery-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yugabyte/.