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 Ybc Management API

The Ybc Management API from YugabyteDB — 5 operation(s) for ybc management.

YugabyteDB Ybc 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 Ybc 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 5 operations across 5 paths, and defines 6 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.

5 operations 5 paths 6 schemas 1 POST4 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 Ybc 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 5

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

Ybc Management 5
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/disable
YugabyteDB Anywhere Disable YBC on the Universe Nodes
disableYbc 3 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/install
YugabyteDB Anywhere Install YBC on the Universe Nodes
installYbc 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade
YugabyteDB Anywhere Upgrade YBC on the Universe Nodes
upgradeYbc 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade/gflags
YugabyteDB Anywhere Upgrade YBC Gflags on the Universe Nodes
upgradeYbcGflags 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params_async
YugabyteDB Anywhere Set Throttle Params in YB-Controller( Async )
setThrottleParams 3 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are YbcThrottleParameters_2 (7 properties), YbcThrottleParameters (7 properties), YBPSuccess_2 (2 properties), YBPTask_2 (2 properties). Each schema is shown below with its type and property counts.

YbcThrottleParameters
object
YB-Controller throttle parameters
7 properties
YBPTask
object
2 properties
YBPSuccess
object
2 properties
YbcThrottleParameters_2
object
YB-Controller throttle parameters
7 properties
YBPTask_2
object
2 properties
YBPSuccess_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-ybc-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