YugabyteDB Universe information 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 information. 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
12 operations
across 11 paths,
and defines 15 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.
12 operations11 paths15 schemas1 DELETE11 GET
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Universe information 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 12
Across 11 paths, the API surfaces 12 operations — 1 DELETE, 11 GET. Each is listed below with its method, path, parameters, and response codes.
Universe information 12
GET
/api/v1/customers/{cUUID}/cost
YugabyteDB Anywhere Get a Cost Estimate for All Universes
YugabyteDB Anywhere Download a Node's Logs - Deprecated
downloadNodeLogs3 params→ 200
Schemas 15
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are UniverseResourceDetails_2 (11 properties), NodeData (11 properties), UniverseResourceDetails (11 properties), NodeData_2 (11 properties). Each schema is shown below with its type and property counts.
Metric
object
4 properties4 required
UniverseResourceDetails
object
11 properties
Details
object
5 properties4 required
MetricValue
object
2 properties2 required
TriggerHealthCheckResult
object
The response type for triggering a health check. Contains the timestamp of when the health check was triggered.
1 property
MasterInfo
object
Information about master
5 properties5 required
MetricLabel
object
2 properties2 required
NodeData
object
11 properties10 required
Metric_2
object
4 properties4 required
UniverseResourceDetails_2
object
11 properties
Details_2
object
5 properties4 required
MetricValue_2
object
2 properties2 required
MasterInfo_2
object
Information about master
5 properties5 required
MetricLabel_2
object
2 properties2 required
NodeData_2
object
11 properties10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
