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.

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

Specifications

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/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/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.

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 differs across the merged source definitions and was not carried
  - x-source-url differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Backups across 6 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-aeon-openapi.yml, yugabytedb-anywhere-v1-backups-restore.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. 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:
- name: Backups
paths:
  /api/v1/customers/{cUUID}/backups:
    delete:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use 'Delete backups V2' instead.
      operationId: deleteBackups
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTasks'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete Backups - deprecated
      tags:
      - Backups
    post:
      operationId: createbackup
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupRequestParams'
        description: Backup data to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create a backup V2
      tags:
      - Backups
      x-codegen-request-body-name: Backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/backups/delete:
    post:
      operationId: deleteBackupsV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBackupParams'
        description: Parameters of the backup to be deleted
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTasks'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete backups V2
      tags:
      - Backups
      x-codegen-request-body-name: deleteBackup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/backups/page:
    post:
      operationId: listBackupsV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupPagedApiQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupPagedApiResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List Backups (paginated) V2
      tags:
      - Backups
      x-codegen-request-body-name: PageBackupsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/backups/{backupUUID}:
    get:
      operationId: getBackupV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: backupUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get Backup V2
      tags:
      - Backups
    put:
      description: Edit a backup
      operationId: editBackupV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: backupUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditBackupParams'
        description: Parameters of the backup to be edited
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Edit a backup V2
      tags:
      - Backups
      x-codegen-request-body-name: backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/backups/{backupUUID}/list_increments:
    get:
      operationId: listIncrementalBackups
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: backupUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CommonBackupInfo'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List Incremental backups
      tags:
      - Backups
    servers:
    - url: /
  /api/v1/customers/{cUUID}/backups/{backupUUID}/stop:
    post:
      description: Stop an in-progress backup
      operationId: stopBackup
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: backupUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Stop a backup
      tags:
      - Backups
    servers:
    - url: /
  /api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tables:
    get:
      description: 'WARNING: This is a preview API that could change. List of all restorable entities in the incremental backup chain.'
      operationId: listRestorableKeyspaceTables
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: baseBackupUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/KeyspaceTables'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List of all restorable entities in the incremental backup chain
      tags:
      - Backups
    servers:
    - url: /
  /api/v1/customers/{cUUID}/create_backup_schedule:
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use 'Create Backup Schedule Async' instead.
      operationId: createBackupSchedule
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupRequestParams'
        description: Parameters of the backup to be restored
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create Backup Schedule - deprecated
      tags:
      - Backups
      x-codegen-request-body-name: backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/create_backup_schedule_async:
    post:
      operationId: createBackupScheduleAsync
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupRequestParams'
        description: Parameters of the backup to be restored
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create Backup Schedule Async
      tags:
      - Backups
      x-codegen-request-body-name: backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/restore:
    post:
      description: Restore from a backup V2. Running restore preflight before calling actual restore is recommended.
      operationId: restoreBackupV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreBackupParams'
        description: Parameters of the backup to be restored
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Restore from a backup V2
      tags:
      - Backups
      x-codegen-request-body-name: backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/restore/advanced_restore_preflight:
    post:
      description: 'WARNING: This is a preview API that could change. Advanced restore preflight checks. Recommended to run before actual restore to retrieve the metadata associated with the backup, as well as check for conflicts with existing keyspaces. Additionally, this checks for unsupported tablespaces. In case of restore to PIT this checks whether backup can restore to the timestamp provided, fails otherwise.'
      operationId: advancedRestorePreflight
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Parameters_for_Advanced_Restore_preflight_checks'
        description: Parameters for advanced restore preflight checks
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestorePreflightResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Advanced Restore Preflight checks
      tags:
      - Backups
      x-codegen-request-body-name: AdvancedRestorePreflightParams
    servers:
    - url: /
  /api/v1/customers/{cUUID}/restore/page:
    post:
      operationId: listBackupRestoresV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestorePagedApiQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestorePagedApiResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List Backup Restores (paginated)
      tags:
      - Backups
      x-codegen-request-body-name: PageRestoresRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/restore/preflight:
    post:
      description: Restore preflight checks. Recommended to run before actual restore to retrieve the metadata associated with the backup, as well as check for conflicts with existing keyspaces. Additionally, this checks for unsupported tablespaces. In case of restore to PIT this returns the backup from the backup chain which can be restored to the timestamp provided, fails otherwise.
      operationId: restorePreflight
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Parameters_for_Restore_preflight_checks'
        description: Parameters for restore preflight check
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestorePreflightResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Restore preflight checks
      tags:
      - Backups
      x-codegen-request-body-name: RestorePreflightParams
    servers:
    - url: /
  /api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tables:
    post:
      description: 'WARNING: This is a preview API that could change. Validate keyspace and tables to Restore against Backup.'
      operationId: validateKeyspaceTablesToRestore
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Parameters_for_validating_Restorable_keyspace_and_tables_in_backup'
        description: Parameters for validating Restorable keyspace and tables
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Validate keyspace and tables to Restore against Backup
      tags:
      - Backups
      x-codegen-request-body-name: RestoreItemsValidationParams
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/backups:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use 'List Backups (paginated) V2' instead.
      operationId: ListOfBackups
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Backup'
                type: array
          description: successful operation
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPError'
          description: If there was a server or database issue when listing the backups
      security:
      - apiKeyAuth: []
      summary: List a customer's backups - deprecated
      tags:
      - Backups
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restore:
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use 'Restore from a backup V2' instead.
      operationId: restore
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupTableParams'
        description: Parameters of the backup to be restored
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Restore from a backup - deprecated
      tags:
      - Backups
      x-codegen-request-body-name: backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}:
    get:
      operationId: fetchBackupsByTaskUUID
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Backup'
                type: array
          description: successful operation
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPError'
          description: If there was a server or database issue when listing the backups
      security:
      - apiKeyAuth: []
      summary: List backups associated with a task
      tags:
      - Backups
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backup:
    put:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use BackupsController.
      operationId: createMultiTableBackup
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiTableBackupRequestParams'
        description: Table backup data to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
          description: If requested schedule backup.
      security:
      - apiKeyAuth: []
      summary: Create a multi-table backup - deprecated
      tags:
      - Backups
      x-codegen-request-body-name: Table backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup:
    put:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>Use BackupsController.
      operationId: createSingleTableBackup
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupTableParams'
        description: Backup data to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create a single-table backup - deprecated
      tags:
      - Backups
      x-codegen-request-body-name: Backup
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state:
    put:
      description: Available since YBA version 2.2.0.0.
      operationId: setUniverseBackupFlag
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: markActive
        schema:
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set a universe's backup flag
      tags:
      - Backups
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params:
    get:
      operationId: getThrottleParams
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YbcThrottleParametersResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get throttle params from YB-Controller
      tags:
      - Backups
    post:
      description: <b style="color:#ff0000">Deprecated since YBA version 2025.2.0.0.</b></p>Use 'Set throttle params in YB-Controller( async )' instead.
      operationId: setThrottleParams
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/YbcThrottleParameters'
        description: Parameters for YB-Controller throttling
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set throttle params in YB-Controller - deprecated
      tags:
      - Backups
      x-codegen-request-body-name: throttleParams
    servers:
    - url: /
  /api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backup:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: Universe Backup
      parameters:
      - in: path
        name: customerUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: universeUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UniverseBackupRequestFormData'
        description: Universe Backup data to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create a Universe Backup
      tags:
      - Backups
      x-codegen-request-body-name: Backup Universe
    servers:
    - url: /
  /accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups:
    get:
      operationId: listBackups
      summary: YugabyteDB Aeon List Backups
      description: Returns all backups for the specified cluster, including both scheduled and on-demand backups. Each entry includes backup state, creation time, expiry time, and size information.
      tags:
      - Backups
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/clusterId'
      responses:
        '200':
          description: List of backups returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Backup_3'
              examples:
                ListBackups200Example:
                  summary: Default listBackups 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      cluster_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      state: SUCCEEDED
                      backup_type: SCHEDULED
                      retention_period_in_days: 100
                      created_at: '2026-05-03T12:00:00Z'
                      expiry_time: '2026-05-03T12:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    post:
      operationId: createBackup
      summary: YugabyteDB Aeon Create On-demand Backup
      description: Triggers an immediate on-demand backup of the specified cluster. The backup is a full cluster snapshot stored in the same region as the cluster. Retention period can be specified in days.
      tags:
      - Backups
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/projectId'
      - $ref: '#/components/parameters/clusterId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupSpec'
            examples:
              CreateBackupRequestExample:
                summary: Default createBackup request
                x-microcks-default: true
                value:
                  retention_period_in_days: 100
      responses:
        '200':
          description: Backup initiated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Backup_3'
              examples:
                CreateBackup200Example:
                  summary: Default createBackup 200 response
                  x-microcks-default: true
                  value:
                    id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    cluster_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    state: SUCCEEDED
                    backup_type: SCHEDULED
                    retention_period_in_days: 100
                    created_at: '2026-05-03T12:00:00Z'
                    expiry_time: '2026-05-03T12:00:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://cloud.yugabyte.com/api/public/v1
      description: YugabyteDB Aeon Production Server
components:
  schemas:
    BackupPagedApiQuery:
      example:
        filter:
          showHidden: true
          dateRangeEnd: 2022-12-12 13:07:18+00:00
          storageConfigUUIDList:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          keyspaceList:
          - keyspaceList
          - keyspaceList
          dateRangeStart: 2022-12-12 13:07:18+00:00
          backupUUIDList:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          scheduleUUIDList:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          universeNameList:
          - universeNameList
          - universeNameList
          onlyShowDeletedConfigs: true
          universeUUIDList:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          onlyShowDeletedUniverses: true
          states:
          - InProgress
          - InProgress
        offset: 6
        needTotalCount: true
        limit: 0
        sortBy: createTime
        direction: ASC
      properties:
        direction:
          enum:
          - ASC
          - DESC
          type: string
        filter:
          $ref: '#/components/schemas/BackupApiFilter'
        limit:
          format: int32
          type: integer
        needTotalCount:
          type: boolean
        offset:
          format: int32
          type: integer
        sortBy:
          enum:
          - createTime
          type: string
      required:
      - direction
      - filter
      - limit
      - needTotalCount
      - offset
      - sortBy
      type: object
    CloudVolumeEncryption:
      description: Volume encryption settings for AWS EBS volumes
      example:
        enableVolumeEncryption: true
        kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        enableVolumeEncryption:
          description: To enable volume encryption or not
          type: boolean
        kmsConfigUUID:
          description: KMS config UUID to be used for volume encryption
          format: uuid
          type: string
      type: object
    Tablespace:
      example:
        replicaPlacement:
          numReplicas: 1
          placementBlocks:
          - cloud: cloud
            leader_preference: 1
            zone: zone
            min_num_replicas: 1
            region: region
          - cloud: cloud
            leader_preference: 1
            zone: zone
            min_num_replicas: 1
            region: region
          - cloud: cloud
            leader_preference: 1
            zone: 

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