YugabyteDB Backups API
Manage backup schedules and trigger on-demand backups for YugabyteDB Aeon clusters. Backups are stored in the same region as the cluster.
YugabyteDB Backups API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Backups. 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 27 operations across 23 paths, and defines 105 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.
27 operations
23 paths
105 schemas
1 DELETE7 GET15 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Backups 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 27
Across 23 paths, the API surfaces 27 operations — 1 DELETE, 7 GET, 15 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Backups 27
Manage backup schedules and trigger on-demand backups for YugabyteDB Aeon clusters. Backups are stored in the same region as the cluster.
GET
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups
YugabyteDB Aeon List Backups
POST
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups
YugabyteDB Aeon Create On-demand Backup
DELETE
/api/v1/customers/{cUUID}/backupsdeprecated
YugabyteDB Anywhere Delete Backups - Deprecated
POST
/api/v1/customers/{cUUID}/backups
YugabyteDB Anywhere Create a Backup V2
POST
/api/v1/customers/{cUUID}/backups/delete
YugabyteDB Anywhere Delete Backups V2
POST
/api/v1/customers/{cUUID}/backups/page
YugabyteDB Anywhere List Backups (paginated) V2
GET
/api/v1/customers/{cUUID}/backups/{backupUUID}
YugabyteDB Anywhere Get Backup V2
PUT
/api/v1/customers/{cUUID}/backups/{backupUUID}
YugabyteDB Anywhere Edit a Backup V2
GET
/api/v1/customers/{cUUID}/backups/{backupUUID}/list_increments
YugabyteDB Anywhere List Incremental Backups
POST
/api/v1/customers/{cUUID}/backups/{backupUUID}/stop
YugabyteDB Anywhere Stop a Backup
GET
/api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tables
YugabyteDB Anywhere List of All Restorable Entities in the Incremental Backup Chain
POST
/api/v1/customers/{cUUID}/create_backup_scheduledeprecated
YugabyteDB Anywhere Create Backup Schedule - Deprecated
POST
/api/v1/customers/{cUUID}/create_backup_schedule_async
YugabyteDB Anywhere Create Backup Schedule Async
POST
/api/v1/customers/{cUUID}/restore
YugabyteDB Anywhere Restore from a Backup V2
POST
/api/v1/customers/{cUUID}/restore/advanced_restore_preflight
YugabyteDB Anywhere Advanced Restore Preflight Checks
POST
/api/v1/customers/{cUUID}/restore/page
YugabyteDB Anywhere List Backup Restores (paginated)
POST
/api/v1/customers/{cUUID}/restore/preflight
YugabyteDB Anywhere Restore Preflight Checks
POST
/api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tables
YugabyteDB Anywhere Validate Keyspace and Tables to Restore Against Backup
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/backupsdeprecated
YugabyteDB Anywhere List a Customer's Backups - Deprecated
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restoredeprecated
YugabyteDB Anywhere Restore from a Backup - Deprecated
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}
YugabyteDB Anywhere List Backups Associated with a Task
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backupdeprecated
YugabyteDB Anywhere Create a Multi-table Backup - Deprecated
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backupdeprecated
YugabyteDB Anywhere Create a Single-table Backup - Deprecated
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params
YugabyteDB Anywhere Get Throttle Params from YB-Controller
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params
YugabyteDB Anywhere Set Throttle Params in YB-Controller - Deprecated
POST
/api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backup
YugabyteDB Anywhere Create a Universe Backup
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state
YugabyteDB Anywhere Set a Universe's Backup Flag
Schemas 105
The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are BackupTableParams_2 (71 properties), MultiTableBackupRequestParams_2 (71 properties), BackupTableParams (71 properties), MultiTableBackupRequestParams (71 properties). Each schema is shown below with its type and property counts.
ReplicaPlacement
object
2 properties
2 required
Parameters for Restore preflight checks
object
4 properties
2 required
NodeDetails
object
Details of a cloud node
37 properties
Parameters for validating Restorable keyspace and tables in backup
object
3 properties
1 required
BackupResp
object
21 properties
18 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
BackupTableParams
object
Backup table parameters
71 properties
7 required
RestoreKeyspace
object
Keyspace level restores
11 properties
1 required
YbcThrottleParametersResponse
object
YB-Controller throttle parameters response
1 property
YBPTask
object
2 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
YBPTasks
object
PerLocationBackupInfo
object
6 properties
MultiTableBackupRequestParams
object
Multi-table backup parameters
71 properties
7 required
BackupSpec
object
Specification for creating an on-demand cluster backup.
1 property
EditBackupParams
object
Edit backup parameters
3 properties
Backup
object
A backup snapshot of a YugabyteDB Aeon cluster.
7 properties
BackupStorageInfo
object
Backup Storage Info for doing restore operation
13 properties
Parameters for Advanced Restore preflight checks
object
4 properties
3 required
TablespaceResponse
object
3 properties
3 required
KeyspaceTable
object
Keyspace and table info for backup
3 properties
PerBackupLocationKeyspaceTables
object
2 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
YbcThrottleParameters
object
YB-Controller throttle parameters
7 properties
YBPSuccess
object
2 properties
RestorePagedApiQuery
object
6 properties
6 required
UniverseBackupRequestFormData
object
Universe Backup Form Data
5 properties
1 required
RestorePagedApiResponse
object
4 properties
4 required
KeyspaceTablesList
object
8 properties
8 required
RegionLocations
object
3 properties
3 required
Backup_2
object
A single backup. Includes the backup's status, expiration time, and configuration.
23 properties
3 required
RestoreApiFilter
object
10 properties
8 required
ExtraDependencies
object
Extra dependencies
1 property
BackupPointInTimeRestoreWindow
object
2 properties
2 required
PlacementBlock
object
5 properties
3 required
BackupPagedApiResponse
object
4 properties
4 required
RestorePreflightResponse
object
3 properties
BackupApiFilter
object
12 properties
10 required
BackupRequestParams
object
Backup table parameters
58 properties
7 required
BackupPagedApiQuery
object
6 properties
6 required
Users
object
A user associated with a customer
12 properties
3 required
DeviceInfo
object
Device information
8 properties
Tablespace
object
2 properties
2 required
ErrorResponse
object
Standard error response returned by the API on failure.
1 property
DeleteBackupParams
object
2 properties
1 required
RestoreResp
object
14 properties
10 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
PresetThrottleValues
object
3 properties
3 required
CommunicationPorts
object
Communication ports
15 properties
RestoreBackupParams
object
40 properties
5 required
KeyspaceTables
object
2 properties
CommonBackupInfo
object
13 properties
10 required
ThrottleParamValue
object
2 properties
2 required
DeleteBackupInfo
object
2 properties
1 required
Schedule
object
Backup schedule
17 properties
1 required
ReplicaPlacement_2
object
2 properties
2 required
Parameters for Restore preflight checks_2
object
4 properties
2 required
NodeDetails_2
object
Details of a cloud node
37 properties
Parameters for validating Restorable keyspace and tables in backup_2
object
3 properties
1 required
BackupResp_2
object
21 properties
18 required
BackupTableParams_2
object
Backup table parameters
71 properties
7 required
RestoreKeyspace_2
object
Keyspace level restores
11 properties
1 required
YbcThrottleParametersResponse_2
object
YB-Controller throttle parameters response
1 property
YBPTask_2
object
2 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
PerLocationBackupInfo_2
object
6 properties
MultiTableBackupRequestParams_2
object
Multi-table backup parameters
71 properties
7 required
Backup_3
object
A single backup. Includes the backup's status, expiration time, and configuration.
23 properties
3 required
EditBackupParams_2
object
Edit backup parameters
3 properties
BackupStorageInfo_2
object
Backup Storage Info for doing restore operation
13 properties
Parameters for Advanced Restore preflight checks_2
object
4 properties
3 required
TablespaceResponse_2
object
3 properties
3 required
KeyspaceTable_2
object
Keyspace and table info for backup
3 properties
PerBackupLocationKeyspaceTables_2
object
2 properties
CloudSpecificInfo_2
object
Node information reported by the cloud provider
18 properties
YbcThrottleParameters_2
object
YB-Controller throttle parameters
7 properties
YBPSuccess_2
object
2 properties
RestorePagedApiQuery_2
object
6 properties
6 required
UniverseBackupRequestFormData_2
object
Universe Backup Form Data
5 properties
1 required
RestorePagedApiResponse_2
object
4 properties
4 required
KeyspaceTablesList_2
object
8 properties
8 required
RegionLocations_2
object
3 properties
3 required
RestoreApiFilter_2
object
10 properties
8 required
ExtraDependencies_2
object
Extra dependencies
1 property
BackupPointInTimeRestoreWindow_2
object
2 properties
2 required
PlacementBlock_2
object
5 properties
3 required
BackupPagedApiResponse_2
object
4 properties
4 required
RestorePreflightResponse_2
object
3 properties
BackupApiFilter_2
object
12 properties
10 required
BackupRequestParams_2
object
Backup table parameters
58 properties
7 required
BackupPagedApiQuery_2
object
6 properties
6 required
Users_2
object
A user associated with a customer
12 properties
3 required
DeviceInfo_2
object
Device information
8 properties
Tablespace_2
object
2 properties
2 required
DeleteBackupParams_2
object
2 properties
1 required
RestoreResp_2
object
14 properties
10 required
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
PresetThrottleValues_2
object
3 properties
3 required
CommunicationPorts_2
object
Communication ports
15 properties
RestoreBackupParams_2
object
40 properties
5 required
KeyspaceTables_2
object
2 properties
CommonBackupInfo_2
object
13 properties
10 required
ThrottleParamValue_2
object
2 properties
2 required
DeleteBackupInfo_2
object
2 properties
1 required
Schedule_2
object
Backup schedule
17 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YugabyteDB 12
Other APIs YugabyteDB publishes across the network.
YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
YugabyteDB Clusters API
#Backups