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 Asynchronous Replication API

The Asynchronous Replication API from YugabyteDB — 6 operation(s) for asynchronous replication.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 9 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

9 operations 6 paths 19 schemas 1 DELETE1 GET6 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 Asynchronous Replication 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 9

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

Asynchronous Replication 9
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/need_bootstrap
Whether tables need bootstrap before setting up cross cluster replication
needBootstrapTable 5 params body → 200
POST
/api/v1/customers/{cUUID}/xcluster_configs
Create xcluster config
createXClusterConfig 2 params body → 200
POST
/api/v1/customers/{cUUID}/xcluster_configs/syncdeprecated
Sync xcluster config - deprecated
syncXClusterConfig 3 params → 200
DELETE
/api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}
Delete xcluster config
deleteXClusterConfig 4 params → 200
GET
/api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}
Get xcluster config
getXClusterConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}
Restart xcluster config
restartXClusterConfig 4 params body → 200
PUT
/api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}
Edit xcluster config
editXClusterConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/need_bootstrap
Whether tables in an xCluster replication config have fallen far behind and…
NeedBootstrapXClusterConfig 3 params body → 200
POST
/api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/sync
Sync xcluster config (V2)
syncXClusterConfigV2 3 params → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are XClusterConfigGetResp (27 properties), TableInfoResp (16 properties), PitrConfig (16 properties), XClusterTableConfig (13 properties). Each schema is shown below with its type and property counts.

BootstrapBackupParams
object
Backup parameters for bootstrapping
2 properties 1 required
NamespaceInfoResp
object
Namespace information response
3 properties
PitrConfig
object
PITR config created on the universe
16 properties 3 required
XClusterConfigEditFormData
object
xcluster edit form
9 properties
XClusterNamespaceConfig
object
7 properties 3 required
YBPTask
object
2 properties
XClusterConfigCreateFormData
object
xcluster create form
7 properties 4 required
XClusterConfigGetResp
object
xcluster get response
27 properties 2 required
RestartBootstrapParams
object
Bootstrap parameters for restarting
1 property 1 required
XClusterConfigNeedBootstrapFormData
object
3 properties 1 required
XClusterTableConfig
object
13 properties 2 required
BootstrapParams
object
Bootstrap parameters
3 properties 1 required
TableInfoResp
object
Table information response
16 properties
XClusterConfigRestartFormData
object
xcluster restart form
3 properties 1 required
XClusterConfigEditFormData_2
object
xcluster edit form
3 properties
YBPTask_2
object
2 properties
XClusterConfigCreateFormData_2
object
xcluster create form
4 properties 4 required
XClusterConfigGetResp_2
object
xcluster get response
10 properties 2 required
XClusterConfig
object
xcluster config object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-asynchronous-replication-api-openapi.yml Raw ↑
#Asynchronous Replication
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-asynchronous-replication-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-asynchronous-replication-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-asynchronous-replication-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 Asynchronous Replication 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.