Restore domain from backup by path

PUT

/domains/{domain}/restore

Last modified:2026-10-03 15:15:31

OperationId:RestoreDomainBackup

Restores the domain in the path from one of its backups. This overwrites the domain's current data: the backup's database files are imported, the domain's stored files are restored, and the domain is reloaded.

Requires Reseller or Super User scope.

List the restore points with GET /domains/{domain}/restore first. Send the chosen point's server as hostname, its type, its day as index, and its confirmation-value in the body. A missing field returns 400 naming it. Values that do not identify exactly one current restore point also return 400.

The call waits for the restore to finish, which can take up to 5 minutes. With geo set to yes, the restore is queued instead, and the response carries only logs.

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/jsonRequired

Examples

Responses

🟢200OK

application/json

The restore finished, or with geo set to yes, it was queued. resultsArr reports each imported database file.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

🔴502Bad Gateway

🔴504Gateway Timeout

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/restore' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "hostname": "core1.example.com",
    "type": "nightly",
    "index": 2,
    "confirmation-value": "89e6c98d92887913cadf06b2adb97f26cde4849b"
}'

Response Example

200 - Restored

{
    "core-server": "core1.example.com",
    "domain": "example.com",
    "type": "nightly",
    "ordinal-order": 2,
    "resultsArr": {
        "SiPbxDomain.2.example.com.sql.gz": {
            "queries": 412,
            "error": 0,
            "success": 412
        },
        "NsApi.2.example.com.sql.gz": {
            "queries": 96,
            "error": 0,
            "success": 96
        }
    },
    "syncResults": {},
    "logs": "https://grafana.example.com/d/ns-nsbackup?var-node=core1.example.com&var-search=example.com&from=now-2h&to=now"
}

Modified at 2026-10-03 15:15:31

List domain restore points

Back up domain