Start full system backup

POST

/backup

Last modified:2026-10-30 21:11:50

OperationId:RequestFullSystemBackup

Starts the backup job in the background for every domain on the server that answers, and returns as soon as it starts. Requires Super User scope. To back up one domain instead, name it in domain: the request then needs the same access as POST /domains/{domain}/backup and waits for that backup to finish.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Without domain, the backup started. With domain, the backup of that domain finished, and backup-index identifies the new restore point.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠409Conflict

🔴502Bad Gateway

🔴504Gateway Timeout

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/backup' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "example.com"
}'

Response Example

200 - Started

{
    "status": "starting backup",
    "backup-log-link": "https://grafana.example.com/d/ns-nsbackup?var-node=core1.example.com&var-search=.%2A&from=now-2h&to=now"
}

Modified at 2026-10-30 21:11:50

Back up domain

List restore points