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

Yugabyte Xcluster Namespace Details API

The Xcluster Namespace Details API from Yugabyte — 1 operation(s) for xcluster namespace details.

Yugabyte Xcluster Namespace Details API is one of 10 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Xcluster Namespace Details. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, {protocol}://{host_port}/api.

1 operations 1 paths 6 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.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

Yugabyte Xcluster Namespace Details API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuthToken). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Xcluster Namespace Details 1
GET
/xcluster_namespace_details/{replication_id}
Get list of all xCluster replication group namespace and table details
getXclusterReplicationNamespacesInfo 1 param → 200400500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are xClusterTableInfoInbound (9 properties), xCluster_Namespace_Metrics (6 properties), xClusterPlacementLocation (3 properties), ApiError_error (2 properties). Each schema is shown below with its type and property counts.

NamespacesInfo
object
A single namespace and its corresponding tables participating in the replication
2 properties 2 required
xClusterTableInfoInbound
object
Schema for table details in xCluster replication.
9 properties 8 required
xClusterPlacementLocation
object
Get universe's placement location in xCluster replication.
3 properties
ApiError
object
1 property
ApiError_error
object
2 properties
xCluster_Namespace_Metrics
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-xcluster-namespace-details-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte backup-info API
Yugabyte cluster API
Yugabyte cluster-info API
Yugabyte pitr-info API
Yugabyte restore-info API
Yugabyte voyager-info API
Yugabyte voyager-metrics API
Yugabyte Xcluster Metrics API