Yugabyte cluster-info API
APIs for getting information about an existing cluster
Yugabyte cluster-info 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-info. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 15 operations across 15 paths, and defines 45 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-info API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuthToken).
By default, every request must be authenticated.
Paths & Operations 15
Across 15 paths, the API surfaces 15 operations — 15 GET. Each is listed below with its method, path, parameters, and response codes.
APIs for getting information about an existing cluster
Schemas 45
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are NodeData_metrics (16 properties), SlowQueryResponseYSQLQueryItem (13 properties), NodeData (12 properties), LiveQueryResponseYSQLQueryItem (10 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.