Restore website backup available since version 4.0.0 / 3.7.316 On-Premises

Restores site backup from local file or remote URL.

Request JSON Object Properties:

• String domain - domain name used to identify web-site witch will be restored from backup (required).
• String file - absolute path inside builder server or absolute external URL to backup file to restore from (required).

On success you will get JSON encoded object as response. HTTP response code should be 200.

Response on Success JSON Object Properties:

• Boolean ok - it will be equal to true to indicate success.

Response on Error JSON Object Properties:

On error you will get JSON encoded object as response. HTTP response code should be something other than 200.

• Object error - error description object (only on error). Error object structure:
  • Number code - error code
  • String message - text describing the error

Request example:

POST /api/restore-site-backup HTTP/1.1
Host: your-on-premises-builder-domain.com
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
    "domain": "site-to-restore.com",
    "file": "/mnt/backup_storage/site-to-restore.com_project.sitebuilder"
}

Response on success example:

HTTP/1.1 200 OK
Content-Type: application/json

{"ok": true}

Response on error example:

HTTP/1.1 500 Internal Error
Content-Type: application/json

{"error": {"code": 1, "message": "some kind of error message"}}