Yugabyte

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.

GitHub OpenAPI

Operations 27

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 #

Documentation

📖
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/
📖
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/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-backups-api-openapi.yml

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yugabytedb-backups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yugabytedb-backups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb Backups API
  version: v1
  x-refined-note:
  - x-generated-from differs across the merged source definitions and was not carried
  - x-last-validated differs across the merged source definitions and was not carried
  - x-source-url differs across the merged source definitions and was not carried
  description: 'Operations tagged Backups across 3 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-aeon-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
tags:


# --- truncated at 32 KB (271 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-backups-api-openapi.yml