YugabyteDB Continuous Backup API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Continuous Backup. 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
5 operations
across 3 paths,
and defines 7 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.
5 operations3 paths7 schemas1 DELETE1 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Continuous Backup 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 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ContinuousBackupSpec_2 (5 properties), ContinuousBackupSpec (5 properties), ContinuousBackupInfo (3 properties), ContinuousRestoreSpec (2 properties). Each schema is shown below with its type and property counts.
YBATask
object
YBATask YugabyteDB Anywhere Task object is used to represent a task that is being executed on a resource. This Task object can be polled for progress and statu…
2 properties
ContinuousBackupInfo
object
ContinuousBackupInfo These are read-only system generated properties of a continuous backup configuration. Returned as part of the Continuous Backup resource.
3 properties1 required
TimeUnitType
string
TimeUnitType Time units that correspond to TimeUnit.java enum. Used for variable frequencies.
ContinuousBackup
object
ContinuousBackup Continuous Backup object which contains the info for a configuration.
2 properties
ContinuousRestoreSpec
object
ContinuousRestoreSpec Continuous Backup Restore time properties. Used to Restore from continuous backup configuration.
2 properties2 required
ContinuousBackupSpec
object
ContinuousBackupSpec User specification for a continuous backup of YBA. All these properties can be edited.
5 properties4 required
ContinuousBackupSpec_2
object
ContinuousBackupSpec User specification for a continuous backup of YBA. All these properties can be edited.
5 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
