YugabyteDB Node instances API
The Node instances API from YugabyteDB — 10 operation(s) for node instances.
YugabyteDB Node instances API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Node instances. 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 11 operations across 10 paths, and defines 19 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Node instances 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 11
Across 10 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 19
The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are NodeDetailsResp_2 (39 properties), NodeDetailsResp (39 properties), CloudSpecificInfo_2 (18 properties), CloudSpecificInfo (18 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 YugabyteDB 12
Other APIs YugabyteDB publishes across the network.