Skip to content
Install

Trigger a new database backup (asynchronous)

POST
/databases/{id}/backups
curl --request POST \
--url https://example.com/databases/example/backups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "label": "example", "type": "full" }'

Auth: authenticated (scope: deploy)

id
required
string
Media typeapplication/json
object
label
string
type
string
Allowed values: full diff incr

OK

Media typeapplication/json
object
backupName
required
string
completedAt
string | null
createdAt
required
string
createdBy
string | null
databaseId
required
string
errorMessage
string | null
id
required
string
label
required
string
sizeBytes
Any of:
string
status
required
string
type
required
string
key
additional properties

Example generated

{
"backupName": "example",
"completedAt": "example",
"createdAt": "example",
"createdBy": "example",
"databaseId": "example",
"errorMessage": "example",
"id": "example",
"label": "example",
"sizeBytes": "example",
"status": "example",
"type": "example"
}