Sign in

v51

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

Back up Essentials database

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

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

Path parameters

subscriptionIdinteger required

Subscription ID.

databaseIdinteger required

Database ID.

Request body

subscriptionIdinteger
databaseIdinteger
adhocBackupPathstring

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

commandTypestring

Example request

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

Response

OK

taskIdstring uuid
commandTypestring
status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'
descriptionstring
timestampstring date-time
linksobject[]