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 Universe CDC Management API

The Universe CDC Management API from YugabyteDB — 3 operation(s) for universe cdc management.

YugabyteDB Universe CDC Management API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Universe CDC Management. 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 4 operations across 3 paths. 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.

4 operations 3 paths 0 schemas 1 DELETE2 GET1 POST

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 Universe CDC Management 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 4

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

Universe CDC Management 4
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/cdc_replication_slots
YugabyteDB Anywhere List CDC Replication Slot for a Cluster
listReplicationSlot 2 params → default
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/cdc_streams
YugabyteDB Anywhere List CDC Streams for a Cluster
listCdcStreams 2 params → default
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/cdc_streams
YugabyteDB Anywhere Create CDC Stream for a Cluster
createCdcStream 3 params → default
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/cdc_streams/{streamId}
YugabyteDB Anywhere Delete a CDC Stream for a Cluster
deleteCdcStream 3 params → default

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-universe-cdc-management-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