v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01169142751.2 KB

Databases - Pro

Back up Pro database

Manually back up the specified Pro database to a backup path. By default, backups will be stored in the 'remoteBackup' location for this database.

post/v1/subscriptions/{subscriptionId}/databases/{databaseId}/backup

Path parameters

subscriptionIdinteger required

Subscription ID.

databaseIdinteger required

Database ID.

Request body

subscriptionIdinteger

databaseIdinteger

regionNamestring

Required for Active-Active databases. Name of the cloud provider region to back up. When backing up an Active-Active database, you must back up each region separately.

adhocBackupPathstring

Optional. Manually backs up data to this location, instead of the set 'remoteBackup' location.

commandTypestring

Example request

{
  "adhocBackupPath": "s3://<backup-path>"
}

Response

taskIdstring uuid

commandTypestring

status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'

descriptionstring

timestampstring date-time

linksobject[]