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 177 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against 2 base URLs: /, https://cloud.yugabyte.com/api/public/v1.
27 operations
23 paths
177 schemas
1 DELETE7 GET15 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
YugabyteDB Backups API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).
It accepts HTTP bearer tokens (bearerAuth).
apiKeyAuth— API token passed as headerbearerAuth— 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
DELETE
/api/v1/customers/{cUUID}/backupsdeprecated
Delete Backups - deprecated
POST
/api/v1/customers/{cUUID}/backups
Create a backup V2
POST
/api/v1/customers/{cUUID}/backups/delete
Delete backups V2
POST
/api/v1/customers/{cUUID}/backups/page
List Backups (paginated) V2
GET
/api/v1/customers/{cUUID}/backups/{backupUUID}
Get Backup V2
PUT
/api/v1/customers/{cUUID}/backups/{backupUUID}
Edit a backup V2
GET
/api/v1/customers/{cUUID}/backups/{backupUUID}/list_increments
List Incremental backups
POST
/api/v1/customers/{cUUID}/backups/{backupUUID}/stop
Stop a backup
GET
/api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tables
List of all restorable entities in the incremental backup chain
POST
/api/v1/customers/{cUUID}/create_backup_scheduledeprecated
Create Backup Schedule - deprecated
POST
/api/v1/customers/{cUUID}/create_backup_schedule_async
Create Backup Schedule Async
POST
/api/v1/customers/{cUUID}/restore
Restore from a backup V2
POST
/api/v1/customers/{cUUID}/restore/advanced_restore_preflight
Advanced Restore Preflight checks
POST
/api/v1/customers/{cUUID}/restore/page
List Backup Restores (paginated)
POST
/api/v1/customers/{cUUID}/restore/preflight
Restore preflight checks
POST
/api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tables
Validate keyspace and tables to Restore against Backup
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/backupsdeprecated
List a customer's backups - deprecated
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restoredeprecated
Restore from a backup - deprecated
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}
List backups associated with a task
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backupdeprecated
Create a multi-table backup - deprecated
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backupdeprecated
Create a single-table backup - deprecated
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state
Set a universe's backup flag
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params
Get throttle params from YB-Controller
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params
Set throttle params in YB-Controller - deprecated
POST
/api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backup
Create a Universe Backup
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
Schemas 177
The contract defines 177 schemas that model the data the API accepts and returns. The most detailed are BackupTableParams_3 (71 properties), MultiTableBackupRequestParams_4 (71 properties), BackupTableParams (71 properties), MultiTableBackupRequestParams (71 properties). Each schema is shown below with its type and property counts.
BackupPagedApiQuery
object
6 properties
6 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
Tablespace
object
2 properties
2 required
Users
object
A user associated with a customer
12 properties
3 required
KeyspaceTablesList
object
8 properties
8 required
KeyspaceTables
object
2 properties
YbcThrottleParameters
object
YB-Controller throttle parameters
7 properties
ReplicaPlacement
object
2 properties
2 required
CommonBackupInfo
object
13 properties
10 required
UniverseBackupRequestFormData
object
Universe Backup Form Data
5 properties
1 required
BackupPagedApiResponse
object
4 properties
4 required
ExtraDependencies
object
Extra dependencies
1 property
DeviceInfo
object
Device information
8 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
BackupApiFilter
object
12 properties
10 required
MultiTableBackupRequestParams
object
Multi-table backup parameters
71 properties
7 required
YbcThrottleParametersResponse
object
YB-Controller throttle parameters response
1 property
RegionLocations
object
3 properties
3 required
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
RestorePagedApiResponse
object
4 properties
4 required
PresetThrottleValues
object
3 properties
3 required
DeleteBackupInfo
object
2 properties
1 required
Backup
object
A single backup. Includes the backup's status, expiration time, and configuration.
23 properties
3 required
RestoreKeyspace
object
Keyspace level restores
11 properties
1 required
Parameters_for_Advanced_Restore_preflight_checks
object
4 properties
3 required
Parameters_for_Restore_preflight_checks
object
4 properties
2 required
PlacementBlock
object
5 properties
3 required
RestoreApiFilter
object
10 properties
8 required
PerBackupLocationKeyspaceTables
object
2 properties
BackupRequestParams
object
Backup table parameters
58 properties
7 required
BackupStorageInfo
object
Backup Storage Info for doing restore operation
13 properties
RestorePreflightResponse
object
3 properties
DeleteBackupParams
object
2 properties
1 required
RestoreBackupParams
object
40 properties
5 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
NodeDetails
object
Details of a cloud node
37 properties
Schedule
object
Backup schedule
17 properties
1 required
BackupResp
object
21 properties
18 required
TablespaceResponse
object
3 properties
3 required
RestoreResp
object
14 properties
10 required
RestorePagedApiQuery
object
6 properties
6 required
Parameters_for_validating_Restorable_keyspace_and_tables_in_backup
object
3 properties
1 required
EditBackupParams
object
Edit backup parameters
3 properties
YBPTasks
object
BackupTableParams
object
Backup table parameters
71 properties
7 required
ThrottleParamValue
object
2 properties
2 required
CommunicationPorts
object
Communication ports
15 properties
YBPSuccess
object
2 properties
BackupPointInTimeRestoreWindow
object
2 properties
2 required
YBPTask
object
2 properties
PerLocationBackupInfo
object
6 properties
KeyspaceTable
object
Keyspace and table info for backup
3 properties
BackupPagedApiQuery_2
object
6 properties
6 required
KeyspaceTablesList_2
object
6 properties
6 required
BackupPagedApiResponse_2
object
4 properties
4 required
ExtraDependencies_2
object
Extra dependencies
1 property
DeviceInfo_2
object
Device information
7 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
BackupApiFilter_2
object
10 properties
10 required
MultiTableBackupRequestParams_2
object
Multi-table backup parameters
49 properties
1 required
RegionLocations_2
object
2 properties
2 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
Backup_2
object
A single backup. Includes the backup's status, expiration time, and configuration. Changes from upstream: PLAT-2132: time data types are changed from string to…
16 properties
2 required
BackupRequestParams_2
object
Backup table parameters
35 properties
2 required
BackupStorageInfo_2
object
Backup Storage Info for doing restore operation
5 properties
RestoreBackupParams_2
object
28 properties
1 required
YBPError_2
object
Generic error response from the YugabyteDB Anywhere API
3 properties
Schedule_2
object
Backup schedule
10 properties
NodeDetails_2
object
Details of a cloud node
28 properties
BackupResp_2
object
22 properties
22 required
EditBackupParams_2
object
Edit backup parameters
3 properties
BackupTableParams_2
object
Backup table parameters
49 properties
1 required
CommunicationPorts_2
object
Communication ports
11 properties
YBPSuccess_2
object
2 properties
YBPTask_2
object
2 properties
KeyspaceTable_2
object
Keyspace and table info for backup
3 properties
Backup_3
object
A backup snapshot of a YugabyteDB Aeon cluster.
7 properties
ErrorResponse
object
Standard error response returned by the API on failure.
1 property
BackupSpec
object
Specification for creating an on-demand cluster backup.
1 property
BackupPagedApiQuery_3
object
6 properties
6 required
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
Tablespace_2
object
2 properties
2 required
Users_2
object
A user associated with a customer
12 properties
3 required
KeyspaceTablesList_3
object
8 properties
8 required
KeyspaceTables_2
object
2 properties
YbcThrottleParameters_2
object
YB-Controller throttle parameters
7 properties
ReplicaPlacement_2
object
2 properties
2 required
CommonBackupInfo_2
object
13 properties
10 required
UniverseBackupRequestFormData_2
object
Universe Backup Form Data
5 properties
1 required
BackupPagedApiResponse_3
object
4 properties
4 required
ExtraDependencies_3
object
Extra dependencies
1 property
DeviceInfo_3
object
Device information
8 properties
EncryptionAtRestConfig_3
object
Encryption at rest configuration
4 properties
BackupApiFilter_3
object
12 properties
10 required
MultiTableBackupRequestParams_3
object
Multi-table backup parameters
71 properties
7 required
YbcThrottleParametersResponse_2
object
YB-Controller throttle parameters response
1 property
RegionLocations_3
object
3 properties
3 required
CloudSpecificInfo_3
object
Node information reported by the cloud provider
18 properties
RestorePagedApiResponse_2
object
4 properties
4 required
PresetThrottleValues_2
object
3 properties
3 required
DeleteBackupInfo_2
object
2 properties
1 required
Backup_4
object
A single backup. Includes the backup's status, expiration time, and configuration.
23 properties
3 required
RestoreKeyspace_2
object
Keyspace level restores
11 properties
1 required
PlacementBlock_2
object
5 properties
3 required
RestoreApiFilter_2
object
10 properties
8 required
PerBackupLocationKeyspaceTables_2
object
2 properties
BackupRequestParams_3
object
Backup table parameters
58 properties
7 required
BackupStorageInfo_3
object
Backup Storage Info for doing restore operation
13 properties
RestorePreflightResponse_2
object
3 properties
DeleteBackupParams_2
object
2 properties
1 required
RestoreBackupParams_3
object
40 properties
5 required
NodeDetails_3
object
Details of a cloud node
37 properties
Schedule_3
object
Backup schedule
17 properties
1 required
BackupResp_3
object
21 properties
18 required
TablespaceResponse_2
object
3 properties
3 required
RestoreResp_2
object
14 properties
10 required
RestorePagedApiQuery_2
object
6 properties
6 required
EditBackupParams_3
object
Edit backup parameters
3 properties
BackupTableParams_3
object
Backup table parameters
71 properties
7 required
ThrottleParamValue_2
object
2 properties
2 required
CommunicationPorts_3
object
Communication ports
15 properties
YBPSuccess_3
object
2 properties
BackupPointInTimeRestoreWindow_2
object
2 properties
2 required
YBPTask_3
object
2 properties
PerLocationBackupInfo_2
object
6 properties
KeyspaceTable_3
object
Keyspace and table info for backup
3 properties
BackupPagedApiQuery_4
object
6 properties
6 required
CloudVolumeEncryption_3
object
Volume encryption settings for AWS EBS volumes
2 properties
Tablespace_3
object
2 properties
2 required
Users_3
object
A user associated with a customer
12 properties
3 required
KeyspaceTablesList_4
object
8 properties
8 required
KeyspaceTables_3
object
2 properties
YbcThrottleParameters_3
object
YB-Controller throttle parameters
7 properties
ReplicaPlacement_3
object
2 properties
2 required
CommonBackupInfo_3
object
13 properties
10 required
UniverseBackupRequestFormData_3
object
Universe Backup Form Data
5 properties
1 required
BackupPagedApiResponse_4
object
4 properties
4 required
ExtraDependencies_4
object
Extra dependencies
1 property
DeviceInfo_4
object
Device information
8 properties
EncryptionAtRestConfig_4
object
Encryption at rest configuration
4 properties
BackupApiFilter_4
object
12 properties
10 required
MultiTableBackupRequestParams_4
object
Multi-table backup parameters
71 properties
7 required
YbcThrottleParametersResponse_3
object
YB-Controller throttle parameters response
1 property
RegionLocations_4
object
3 properties
3 required
CloudSpecificInfo_4
object
Node information reported by the cloud provider
18 properties
RestorePagedApiResponse_3
object
4 properties
4 required
PresetThrottleValues_3
object
3 properties
3 required
DeleteBackupInfo_3
object
2 properties
1 required
Backup_5
object
A single backup. Includes the backup's status, expiration time, and configuration.
23 properties
3 required
RestoreKeyspace_3
object
Keyspace level restores
11 properties
1 required
Parameters_for_Advanced_Restore_preflight_checks_2
object
4 properties
3 required
Parameters_for_Restore_preflight_checks_2
object
4 properties
2 required
PlacementBlock_3
object
5 properties
3 required
RestoreApiFilter_3
object
10 properties
8 required
PerBackupLocationKeyspaceTables_3
object
2 properties
BackupRequestParams_4
object
Backup table parameters
58 properties
7 required
BackupStorageInfo_4
object
Backup Storage Info for doing restore operation
13 properties
RestorePreflightResponse_3
object
3 properties
DeleteBackupParams_3
object
2 properties
1 required
RestoreBackupParams_4
object
40 properties
5 required
NodeDetails_4
object
Details of a cloud node
37 properties
Schedule_4
object
Backup schedule
17 properties
1 required
BackupResp_4
object
21 properties
18 required
TablespaceResponse_3
object
3 properties
3 required
RestoreResp_3
object
14 properties
10 required
RestorePagedApiQuery_3
object
6 properties
6 required
Parameters_for_validating_Restorable_keyspace_and_tables_in_backup_2
object
3 properties
1 required
EditBackupParams_4
object
Edit backup parameters
3 properties
BackupTableParams_4
object
Backup table parameters
71 properties
7 required
ThrottleParamValue_3
object
2 properties
2 required
CommunicationPorts_4
object
Communication ports
15 properties
YBPSuccess_4
object
2 properties
BackupPointInTimeRestoreWindow_3
object
2 properties
2 required
YBPTask_4
object
2 properties
PerLocationBackupInfo_3
object
6 properties
KeyspaceTable_4
object
Keyspace and table info for backup
3 properties
YBPSuccess_5
object
2 properties
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
Where this information came from
This is an independent, third-party profile of YugabyteDB Backups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.