# YugabyteDB Backups API

**Canonical:** https://apis.io/apis/yugabyte/yugabytedb-backups-api/  
**Provider:** Yugabyte — https://apis.io/providers/yugabyte/  
**Base URL:** https://cloud.yugabyte.com/api/public/v1  
**Documentation:** https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/

YugabyteDB Backups API is one of 82 APIs that [Yugabyte](https://apis.io/providers/yugabyte/) publishes on the [APIs.io](https://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.

Manage backup schedules and trigger on-demand backups for YugabyteDB Aeon clusters. Backups are stored in the same region as the cluster.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/api/v1/customers/{cUUID}/backups` | 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_schedule` | 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}/backups` | List a customer's backups - deprecated |
| POST | `/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restore` | 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_backup` | Create a multi-table backup - deprecated |
| PUT | `/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup` | 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 |

## Machine-readable artifacts (27)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-backups-api-openapi.yml
- **Documentation** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
- **APIReference** — https://api-docs.yugabyte.com/docs/managed-apis/
- **GettingStarted** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
- **Authentication** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
- **CLI** — https://github.com/yugabyte/ybm-cli
- **Integrations** — https://github.com/yugabyte/terraform-provider-ybm
- **TermsOfService** — https://www.yugabyte.com/yugabytedb-managed-service-terms/
- **Documentation** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **APIReference** — https://api-docs.yugabyte.com/docs/yugabyte-platform/
- **GettingStarted** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **Authentication** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **SDKs** — https://github.com/yugabyte/platform-go-client
- **Integrations** — https://github.com/yugabyte/terraform-provider-yba
- **Integrations** — https://github.com/yugabyte/yugabyte-k8s-operator
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-restore-job.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-storage-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-dr-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-pitr-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-release.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-support-bundle.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybprovider.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybplatform.yaml

## Other Yugabyte APIs (12)

- [YugabyteDB Aeon REST API](https://apis.io/apis/yugabyte/yugabytedb-aeon-rest-api/)
- [Yugabyte Backup Info API](https://apis.io/apis/yugabyte/yugabyte-backup-info-api/)
- [Yugabyte Cluster API](https://apis.io/apis/yugabyte/yugabyte-cluster-api/)
- [Yugabyte Cluster Info API](https://apis.io/apis/yugabyte/yugabyte-cluster-info-api/)
- [Yugabyte Pitr Info API](https://apis.io/apis/yugabyte/yugabyte-pitr-info-api/)
- [Yugabyte Restore Info API](https://apis.io/apis/yugabyte/yugabyte-restore-info-api/)
- [Yugabyte Voyager Info API](https://apis.io/apis/yugabyte/yugabyte-voyager-info-api/)
- [Yugabyte Voyager Metrics API](https://apis.io/apis/yugabyte/yugabyte-voyager-metrics-api/)
- [Yugabyte Xcluster Metrics API](https://apis.io/apis/yugabyte/yugabyte-xcluster-metrics-api/)
- [Yugabyte Xcluster Namespace Details API](https://apis.io/apis/yugabyte/yugabyte-xcluster-namespace-details-api/)
- [YugabyteDB Access Keys API](https://apis.io/apis/yugabyte/yugabytedb-access-keys-api/)
- [YugabyteDB Accounts API](https://apis.io/apis/yugabyte/yugabytedb-accounts-api/)

## Tags

Backups

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yugabyte/yugabytedb-backups-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yugabyte/.