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

Reference:

• Request example (when storing locally)
• Response on success (when storing locally) example
• Response on success (when downloading) example
• Response on error example
• Troubleshooting

Creates site source file backup and stores locally on builder server or returns as downloadable file.

JSON Object Properties:

• String domain - domain name used to identify website witch will be backed up (required).
• String dir - absolute folder path inside builder server where to store backup file (optional, if not set backup file will be returned in response for downloading). When backup file is stored locally in provided folder it will have file name: "[domain]_project.sitebuilder".

On success you get empty response (in case of local storage) or response with a file for downloading. HTTP response code should be 200.
On error you will get JSON encoded object as response. HTTP response code should be something other than 200.

Response on Error JSON Object Properties:

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

POST /api/create-site-backup HTTP/1.1
Host: 
Authorization: Basic W0FQSSBVc2VybmFtZSB3aWxsIGFwcGVhciBhZnRlciB5b3UgPGEgaHJlZj0iamF2YXNjcmlwdDp2b2lkKDApIiBjbGFzcz0iYnRuLWxvZ2luLXRyaWdnZXIiPmxvZyBpbjwvYT4gb3IgPGEgaHJlZj0iamF2YXNjcmlwdDp2b2lkKDApIiBjbGFzcz0iYnRuLXJlZ2lzdGVyLXRyaWdnZXIiPnNpZ24gdXA8L2E+XTpbQVBJIFBhc3N3b3JkIHdpbGwgYXBwZWFyIGFmdGVyIHlvdSA8YSBocmVmPSJqYXZhc2NyaXB0OnZvaWQoMCkiIGNsYXNzPSJidG4tbG9naW4tdHJpZ2dlciI+bG9nIGluPC9hPiBvciA8YSBocmVmPSJqYXZhc2NyaXB0OnZvaWQoMCkiIGNsYXNzPSJidG4tcmVnaXN0ZXItdHJpZ2dlciI+c2lnbiB1cDwvYT5d
Content-Type: application/json

{
    "domain": "site-to-backup.com",
    "dir": "/mnt/backup_storage"
}

HTTP/1.1 200 OK

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-disposition: attachment; filename="site-to-backup.com_project.sitebuilder"

[some binary data]

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

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