Start full system backup - NetSapiens API v2

Starts the backup job now for every domain on the server that answers the request. The job runs in the background, and the call returns as soon as it starts.

Requires Super User scope. Super User Read Only and every other scope get 403. This path accepts only POST; any other method returns 405.

To back up one domain instead, send its name in domain. The request then works like Back up domain: it needs the same access, waits for the backup to finish, and returns the same response. A Reseller can name only a domain in its own territory; any other returns 403. A domain that does not exist returns 404.

Only one backup runs at a time: if one is already in progress, the request returns 409, so retry after it finishes. When backup storage is not configured on the server, the request returns 502 with the message missing configs. Contact support to set it up.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

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

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