YugabyteDB Encryption at rest API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Encryption at rest. 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
10 operations
across 7 paths,
and defines 5 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.
10 operations7 paths5 schemas2 DELETE4 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Encryption at rest 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 10
Across 7 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
YugabyteDB Anywhere Get a Universe's Key Reference
getCurrentKeyRef2 params→ 200
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are YBPError (6 properties), YBPSuccess_2 (2 properties), YBPTask_2 (2 properties), YBPSuccess (2 properties). Each schema is shown below with its type and property counts.
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
YBPTask
object
2 properties
YBPSuccess
object
2 properties
YBPTask_2
object
2 properties
YBPSuccess_2
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
