Yugabyte cluster API
APIs for cluster CRUD
Yugabyte cluster API is one of 10 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include cluster. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 3 operations across 1 path, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version v1.
Requests are made against a single base URL, {protocol}://{host_port}/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yugabyte cluster API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuthToken).
By default, every request must be authenticated.
Paths & Operations 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
APIs for cluster CRUD
Schemas 15
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ClusterNodeInfo (6 properties), ClusterInfo (6 properties), ClusterSpec (5 properties), ClusterDataInfo (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yugabyte 9
Other APIs Yugabyte publishes across the network.