How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
YugabyteDB

YugabyteDB Disaster Recovery API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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 57 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

16 operations 15 paths 57 schemas 1 DELETE2 GET12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB Disaster Recovery API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as 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
Create disaster recovery config
createDrConfig 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/dr_configs/{drUUID}
Delete xcluster config
deleteXClusterConfig 4 params → 200
GET
/api/v1/customers/{cUUID}/dr_configs/{drUUID}
Get disaster recovery config
getDrConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/edit
Edit disaster recovery config
editDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/failover
Failover a disaster recovery config
failoverDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause
Pause DR config
pauseDrConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause_universes
Pause DR config and universes associated with DR
pauseDrUniverses 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replica
Replace Replica in a disaster recovery config
replaceReplicaDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/restart
Restart disaster recovery config
restartDrConfig 4 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume
Resume DR config
resumeDrConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume_universes
Resume DR config and universes associated with DR
resumeDrUniverses 3 params → 200
GET
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetime
Get disaster recovery config safetime
getDrConfigSafetime 2 params → 200
PUT
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs
Set databases in disaster recovery config
setDatabasesDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tables
Set tables in disaster recovery config
setTablesDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchover
Switchover a disaster recovery config
switchoverDrConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/dr_configs/{drUUID}/sync
Sync disaster recovery config
syncDrConfig 3 params → 200

Schemas 57

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

NamespaceSafetime
object
6 properties 6 required
BootstrapBackupParams
object
Backup parameters for bootstrapping
2 properties 1 required
DrConfigSetTablesForm
object
dr config set tables form
3 properties
DrConfigReplaceReplicaForm
object
drConfig edit form
3 properties
DrConfigGetResp
object
disaster recovery get response
29 properties 1 required
PitrConfig
object
PITR config created on the universe
16 properties 3 required
RestartBootstrapParams
object
Bootstrap parameters for restarting
1 property 1 required
NamespaceInfoResp
object
Namespace information response
3 properties
DrConfigSafetimeResp
object
Get DR config safetime response
1 property
PitrParams
object
PITR parameters
2 properties
DrConfigSwitchoverForm
object
drConfig failover form
2 properties
DrConfigRestartForm
object
dr config restart form
2 properties 1 required
DrConfigSetDatabasesForm
object
dr config set databases form
1 property
DrConfigCreateForm
object
drConfig create form
7 properties 4 required
XClusterTableConfig
object
13 properties 2 required
DrConfigFailoverForm
object
drConfig failover form
3 properties
GetWebhookResponse
object
Webhook get response
2 properties
TableInfoResp
object
Table information response
16 properties
XClusterNamespaceConfig
object
7 properties 3 required
DrConfigEditForm
object
drConfig edit form
3 properties
YBPTask
object
2 properties
NamespaceSafetime_2
object
6 properties 6 required
BootstrapBackupParams_2
object
Backup parameters for bootstrapping
2 properties 1 required
DrConfigSetTablesForm_2
object
dr config set tables form
3 properties
DrConfigReplaceReplicaForm_2
object
drConfig edit form
3 properties
DrConfigGetResp_2
object
disaster recovery get response
29 properties 1 required
PitrConfig_2
object
PITR config created on the universe
16 properties 3 required
NamespaceInfoResp_2
object
Namespace information response
3 properties
DrConfigSafetimeResp_2
object
Get DR config safetime response
1 property
PitrParams_2
object
PITR parameters
2 properties
DrConfigSwitchoverForm_2
object
drConfig failover form
2 properties
DrConfigCreateForm_2
object
drConfig create form
7 properties 4 required
XClusterTableConfig_2
object
13 properties 2 required
DrConfigFailoverForm_2
object
drConfig failover form
3 properties
GetWebhookResponse_2
object
Webhook get response
2 properties
TableInfoResp_2
object
Table information response
16 properties
XClusterNamespaceConfig_2
object
7 properties 3 required
DrConfigEditForm_2
object
drConfig edit form
3 properties
YBPTask_2
object
2 properties
NamespaceSafetime_3
object
6 properties 6 required
BootstrapBackupParams_3
object
Backup parameters for bootstrapping
2 properties 1 required
DrConfigSetTablesForm_3
object
dr config set tables form
3 properties
DrConfigReplaceReplicaForm_3
object
drConfig edit form
3 properties
DrConfigGetResp_3
object
disaster recovery get response
29 properties 1 required
PitrConfig_3
object
PITR config created on the universe
16 properties 3 required
NamespaceInfoResp_3
object
Namespace information response
3 properties
DrConfigSafetimeResp_3
object
Get DR config safetime response
1 property
PitrParams_3
object
PITR parameters
2 properties
DrConfigSwitchoverForm_3
object
drConfig failover form
2 properties
DrConfigCreateForm_3
object
drConfig create form
7 properties 4 required
XClusterTableConfig_3
object
13 properties 2 required
DrConfigFailoverForm_3
object
drConfig failover form
3 properties
GetWebhookResponse_3
object
Webhook get response
2 properties
TableInfoResp_3
object
Table information response
16 properties
XClusterNamespaceConfig_3
object
7 properties 3 required
DrConfigEditForm_3
object
drConfig edit form
3 properties
YBPTask_3
object
2 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
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Cloud providers API
AE Profile APIs.io
#Disaster Recovery
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-disaster-recovery-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
YugabyteDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-disaster-recovery-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-disaster-recovery-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of YugabyteDB Disaster Recovery API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.