Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Disaster Recovery API

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

YugabyteDB Disaster Recovery API is one of 73 APIs that YugabyteDB publishes on the 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.

This API exposes 16 operations across 15 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

16 operations 15 paths 39 schemas 1 DELETE2 GET12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Disaster Recovery API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 1 DELETE, 2 GET, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Disaster Recovery 16
POST
/api/v1/customers/{cUUID}/dr_configs
YugabyteDB Anywhere Create Disaster Recovery Config
createDrConfig 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/dr_configs/{drUUID}
YugabyteDB Anywhere Delete Xcluster Config
deleteXClusterConfig 4 params → 200
GET
/api/v1/customers/{cUUID}/dr_configs/{drUUID}
YugabyteDB Anywhere Get Disaster Recovery Config
getDrConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/edit
YugabyteDB Anywhere Edit Disaster Recovery Config
editDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/failover
YugabyteDB Anywhere Failover a Disaster Recovery Config
failoverDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause
YugabyteDB Anywhere Pause DR Config
pauseDrConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause_universes
YugabyteDB Anywhere Pause DR Config and Universes Associated with DR
pauseDrUniverses 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replica
YugabyteDB Anywhere Replace Replica in a Disaster Recovery Config
replaceReplicaDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/restart
YugabyteDB Anywhere Restart Disaster Recovery Config
restartDrConfig 4 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume
YugabyteDB Anywhere Resume DR Config
resumeDrConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume_universes
YugabyteDB Anywhere Resume DR Config and Universes Associated with DR
resumeDrUniverses 3 params → 200
GET
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetime
YugabyteDB Anywhere Get Disaster Recovery Config Safetime
getDrConfigSafetime 2 params → 200
PUT
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs
YugabyteDB Anywhere Set Databases in Disaster Recovery Config
setDatabasesDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tables
YugabyteDB Anywhere Set Tables in Disaster Recovery Config
setTablesDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchover
YugabyteDB Anywhere Switchover a Disaster Recovery Config
switchoverDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/sync
YugabyteDB Anywhere Sync Disaster Recovery Config
syncDrConfig 3 params → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are DrConfigGetResp_2 (29 properties), DrConfigGetResp (29 properties), TableInfoResp_2 (16 properties), TableInfoResp (16 properties). Each schema is shown below with its type and property counts.

DrConfigFailoverForm
object
drConfig failover form
3 properties
NamespaceSafetime
object
6 properties 6 required
DrConfigSetTablesForm
object
dr config set tables form
3 properties
DrConfigSafetimeResp
object
Get DR config safetime response
1 property
XClusterNamespaceConfig
object
7 properties 3 required
RestartBootstrapParams
object
Bootstrap parameters for restarting
1 property 1 required
YBPTask
object
2 properties
DrConfigGetResp
object
disaster recovery get response
29 properties 1 required
DrConfigSetDatabasesForm
object
dr config set databases form
1 property
XClusterTableConfig
object
13 properties 2 required
PitrConfig
object
PITR config created on the universe
16 properties 3 required
DrConfigCreateForm
object
drConfig create form
7 properties 4 required
DrConfigEditForm
object
drConfig edit form
3 properties
TableInfoResp
object
Table information response
16 properties
DrConfigRestartForm
object
dr config restart form
2 properties 1 required
DrConfigSwitchoverForm
object
drConfig failover form
2 properties
BootstrapBackupParams
object
Backup parameters for bootstrapping
2 properties 1 required
PitrParams
object
PITR parameters
2 properties
NamespaceInfoResp
object
Namespace information response
3 properties
GetWebhookResponse
object
Webhook get response
2 properties
DrConfigReplaceReplicaForm
object
drConfig edit form
3 properties
DrConfigFailoverForm_2
object
drConfig failover form
3 properties
NamespaceSafetime_2
object
6 properties 6 required
DrConfigSetTablesForm_2
object
dr config set tables form
3 properties
DrConfigSafetimeResp_2
object
Get DR config safetime response
1 property
XClusterNamespaceConfig_2
object
7 properties 3 required
YBPTask_2
object
2 properties
DrConfigGetResp_2
object
disaster recovery get response
29 properties 1 required
XClusterTableConfig_2
object
13 properties 2 required
PitrConfig_2
object
PITR config created on the universe
16 properties 3 required
DrConfigCreateForm_2
object
drConfig create form
7 properties 4 required
DrConfigEditForm_2
object
drConfig edit form
3 properties
TableInfoResp_2
object
Table information response
16 properties
DrConfigSwitchoverForm_2
object
drConfig failover form
2 properties
BootstrapBackupParams_2
object
Backup parameters for bootstrapping
2 properties 1 required
PitrParams_2
object
PITR parameters
2 properties
NamespaceInfoResp_2
object
Namespace information response
3 properties
GetWebhookResponse_2
object
Webhook get response
2 properties
DrConfigReplaceReplicaForm_2
object
drConfig edit form
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-disaster-recovery-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API