Back up domain

POST

/domains/{domain}/backup

Last modified:2026-10-09 00:45:09

OperationId:ManuallyBackupDomain

Runs a manual backup of one domain now, on the server that answers the request. The domain's databases are backed up and its stored files copied to backup storage, and the response reports both.

Requires Reseller or Super User scope. A Reseller can back up only a domain in its own territory. This path accepts only POST; any other method returns 405.

A request body is optional. A domain in the body must name the domain in the path, or the request returns 400. To name the domain in the body instead, use POST /backup.

The call waits for the backup to finish, which can take up to 5 minutes for a large domain. backup-index identifies the new restore point. To see it, use GET /domains/{domain}/restore.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

The backup finished. backup-index identifies the new restore point.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

🔴502Bad Gateway

🔴504Gateway Timeout

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

{
    "backup-hostname": "core1.example.com",
    "backup-index": 202609011430,
    "domain": "example.com",
    "type": "manual",
    "backup-log-link": "https://grafana.example.com/d/ns-nsbackup?var-node=core1.example.com&var-search=example.com&from=now-2h&to=now",
    "data-sync-results": {
        "complete-file-backup-time-ms": 426,
        "uploaded": 8,
        "upload-size": 12466599,
        "note": "This numbers are since last backup/sync",
        "deleted": 2
    },
    "database-backup-results": {
        "status": "complete",
        "duration-main-loop-ms": 858,
        "manual-index": 202609011430,
        "complete-database-backup-time-ms": 861
    }
}

Modified at 2026-10-09 00:45:09

Restore domain from backup by path

Start full system backup