How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yugabyte

Yugabyte Backups API

The Backups API from Yugabyte — 23 operation(s) for backups.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yugabyte Backups API is one of 82 APIs that Yugabyte 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 55 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 55 schemas 1 DELETE7 GET15 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Yugabyte 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 header
  • 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
DELETE
/api/v1/customers/{cUUID}/backupsdeprecated
Delete Backups - deprecated
deleteBackups 2 params → 200
POST
/api/v1/customers/{cUUID}/backups
Create a backup V2
createbackup 2 params body → 200
POST
/api/v1/customers/{cUUID}/backups/delete
Delete backups V2
deleteBackupsV2 2 params body → 200
POST
/api/v1/customers/{cUUID}/backups/page
List Backups (paginated) V2
listBackupsV2 2 params body → 200
GET
/api/v1/customers/{cUUID}/backups/{backupUUID}
Get Backup V2
getBackupV2 2 params → 200
PUT
/api/v1/customers/{cUUID}/backups/{backupUUID}
Edit a backup V2
editBackupV2 3 params body → 200
GET
/api/v1/customers/{cUUID}/backups/{backupUUID}/list_increments
List Incremental backups
listIncrementalBackups 2 params → 200
POST
/api/v1/customers/{cUUID}/backups/{backupUUID}/stop
Stop a backup
stopBackup 3 params → 200
GET
/api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tables
List of all restorable entities in the incremental backup chain
listRestorableKeyspaceTables 2 params → 200
POST
/api/v1/customers/{cUUID}/create_backup_scheduledeprecated
Create Backup Schedule - deprecated
createBackupSchedule 2 params body → 200
POST
/api/v1/customers/{cUUID}/create_backup_schedule_async
Create Backup Schedule Async
createBackupScheduleAsync 2 params body → 200
POST
/api/v1/customers/{cUUID}/restore
Restore from a backup V2
restoreBackupV2 2 params body → 200
POST
/api/v1/customers/{cUUID}/restore/advanced_restore_preflight
Advanced Restore Preflight checks
advancedRestorePreflight 2 params body → 200
POST
/api/v1/customers/{cUUID}/restore/page
List Backup Restores (paginated)
listBackupRestoresV2 2 params body → 200
POST
/api/v1/customers/{cUUID}/restore/preflight
Restore preflight checks
restorePreflight 2 params body → 200
POST
/api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tables
Validate keyspace and tables to Restore against Backup
validateKeyspaceTablesToRestore 2 params body → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/backupsdeprecated
List a customer's backups - deprecated
ListOfBackups 2 params → 200500
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restoredeprecated
Restore from a backup - deprecated
restore 3 params body → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}
List backups associated with a task
fetchBackupsByTaskUUID 3 params → 200500
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backupdeprecated
Create a multi-table backup - deprecated
createMultiTableBackup 3 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backupdeprecated
Create a single-table backup - deprecated
createSingleTableBackup 4 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state
Set a universe's backup flag
setUniverseBackupFlag 4 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params
Get throttle params from YB-Controller
getThrottleParams 2 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params
Set throttle params in YB-Controller - deprecated
setThrottleParams 3 params body → 200
POST
/api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backup
Create a Universe Backup
UniverseBackup 3 params body → 200
GET
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups
YugabyteDB Aeon List Backups
listBackups 3 params → 200401404
POST
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups
YugabyteDB Aeon Create On-demand Backup
createBackup 3 params body → 200400401

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are MultiTableBackupRequestParams (71 properties), BackupTableParams (71 properties), BackupRequestParams (58 properties), RestoreBackupParams (40 properties). Each schema is shown below with its type and property counts.

PlacementBlock
object
5 properties 3 required
BackupResp
object
21 properties 18 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
EditBackupParams
object
Edit backup parameters
3 properties
YBPTask
object
2 properties
ErrorResponse
object
Standard error response returned by the API on failure.
1 property
CommunicationPorts
object
Communication ports
15 properties
ReplicaPlacement
object
2 properties 2 required
YBPSuccess
object
2 properties
Users
object
A user associated with a customer
12 properties 3 required
ThrottleParamValue
object
2 properties 2 required
RestorePagedApiResponse
object
4 properties 4 required
BackupPagedApiQuery
object
6 properties 6 required
DeleteBackupInfo
object
2 properties 1 required
BackupApiFilter
object
12 properties 10 required
ExtraDependencies
object
Extra dependencies
1 property
Tablespace
object
2 properties 2 required
BackupSpec
object
Specification for creating an on-demand cluster backup.
1 property
DeleteBackupParams
object
2 properties 1 required
RestorePreflightResponse
object
3 properties
Backup_3
object
A backup snapshot of a YugabyteDB Aeon cluster.
7 properties
NodeDetails
object
Details of a cloud node
37 properties
KeyspaceTablesList
object
8 properties 8 required
RestorePagedApiQuery
object
6 properties 6 required
PresetThrottleValues
object
3 properties 3 required
YbcThrottleParametersResponse
object
YB-Controller throttle parameters response
1 property
BackupStorageInfo
object
Backup Storage Info for doing restore operation
13 properties
Parameters_for_Restore_preflight_checks
object
4 properties 2 required
RestoreApiFilter
object
10 properties 8 required
PerBackupLocationKeyspaceTables
object
2 properties
Backup
object
A single backup. Includes the backup's status, expiration time, and configuration.
23 properties 3 required
BackupRequestParams
object
Backup table parameters
58 properties 7 required
BackupPagedApiResponse
object
4 properties 4 required
YBPTasks
object
YbcThrottleParameters
object
YB-Controller throttle parameters
7 properties
Parameters_for_validating_Restorable_keyspace_and_tables_in_backup
object
3 properties 1 required
RestoreKeyspace
object
Keyspace level restores
11 properties 1 required
KeyspaceTables
object
2 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
PerLocationBackupInfo
object
6 properties
UniverseBackupRequestFormData
object
Universe Backup Form Data
5 properties 1 required
DeviceInfo
object
Device information
8 properties
KeyspaceTable
object
Keyspace and table info for backup
3 properties
MultiTableBackupRequestParams
object
Multi-table backup parameters
71 properties 7 required
BackupTableParams
object
Backup table parameters
71 properties 7 required
Parameters_for_Advanced_Restore_preflight_checks
object
4 properties 3 required
RestoreBackupParams
object
40 properties 5 required
TablespaceResponse
object
3 properties 3 required
BackupPointInTimeRestoreWindow
object
2 properties 2 required
Schedule
object
Backup schedule
17 properties 1 required
RegionLocations
object
3 properties 3 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
CommonBackupInfo
object
13 properties 10 required
RestoreResp
object
14 properties 10 required
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-backups-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
AE Profile APIs.io
Yugabyte Backup Info API
AE Profile APIs.io
Yugabyte Cluster API
AE Profile APIs.io
Yugabyte Cluster Info API
AE Profile APIs.io
Yugabyte Pitr Info API
AE Profile APIs.io
Yugabyte Restore Info API
AE Profile APIs.io
Yugabyte Voyager Info API
AE Profile APIs.io
Yugabyte Voyager Metrics API
AE Profile APIs.io
Yugabyte Xcluster Metrics API
AE Profile APIs.io
Yugabyte Xcluster Namespace Details API
AE Profile APIs.io
Yugabyte Access Keys API
AE Profile APIs.io
Yugabyte Accounts API
AE Profile APIs.io
#Backups
← Back to Y APIs
API Details
ID
yugabyte:yugabyte-backups-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://api-docs.yugabyte.com/docs/managed-apis/9u5yqnccbe8lk-yugabyte-db-aeon-rest-api
Provider
Yugabyte
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabyte-backups-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabyte-backups-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Yugabyte 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.