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

Yugabyte Ybc Management API

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

Yugabyte Ybc Management API is one of 82 APIs that Yugabyte 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 3 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

5 operations 5 paths 3 schemas 1 POST4 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
Terms of Service
Resource Areas
1

Authentication & Security 1

Yugabyte Ybc Management 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 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
Disable YBC on the universe nodes
disableYbc 3 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/install
Install YBC on the universe nodes
installYbc 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade
Upgrade YBC on the universe nodes
upgradeYbc 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc/upgrade/gflags
Upgrade YBC gflags on the universe nodes
upgradeYbcGflags 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params_async
Set throttle params in YB-Controller( async )
setThrottleParams 3 params body → 200

Schemas 3

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-ybc-management-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
Yugabyte Xcluster Namespace Details API
Yugabyte Access Keys API
Yugabyte Accounts API
Where this information came from

This is an independent, third-party profile of Yugabyte Ybc Management 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.