Site.pro
  • Website Builder
    • Website Builder
    • Prices
    • Website Import
    • Online Stores
    • Plugins
    • Collaboration
    • Templates
    • Languages
    • Affiliate Program
    • Examples
    • AI Website Builder
    • For Design Studios
    • We Build for You
  • Domains
  • Email
  • Learn
    • Tutorials
    • Blog
    • FAQ
    • Growth Hacking
    • For Hostings
    • Domainity
    • For Education
  • For Resellers
    • Prices
    • White Label
    • Revenue Share
    • Panels
    • How it Works
    • Mass Import
    • Our Partners
    • Reselling Examples
    • Marketing Materials
    • Documentation
    • Free Websites
  • Website Builder
    • Website BuilderEverybody can easily create a website, landing page, or e-commerce store.
    • PricesSite.pro Prices: Templates 200+, Websites, Basic Builder Functions, Online Stores
    • Website ImportTransfer your existing website from anywhere to Site.pro website builder
    • Online StoresSell your goods or services anywhere on the website
    • PluginsMany functions and plugins depending on geographical preferences
    • CollaborationCollaborative Website Builder, Create a website with teammates in real-time in one space
    • Templates
    • Languages
    • Affiliate Program
    • Examples
    • AI Website Builder
    • For Design Studios
    • We Build for You
  • Domains
  • Email
  • Learn
    • TutorialsVideos for Beginners
    • BlogWebsite Builder Lifehacks:Shared hosting tips. Web Design, Marketing
    • FAQHelp center. Payment Issues. Basic Tutorial. Quick search.
    • Growth HackingBoost your sales. Strategy
    • For HostingsEducation. Generate more website builder sales
    • DomainityDomainity: Domain quantity per 1000 people
    • For EducationFree Website Builder for Online and Offline Classrooms
  • For ResellersWhite Label
    • PricesStart reselling. Pay for live websites. Free Websites
    • White LabelThe most popular white label tool is ideal for reselling
    • Revenue ShareWebsite Builder: Provide free website builder and earn 50% commissions
    • PanelsOne product for all platforms. Download plugin for your panel
    • How it WorksCloud or On-Premises. Recommendations for Builder Server
    • Marketing MaterialsVideo. Mockups. Website Blocks. Marketing Materials.
    • Mass Import
    • Our Partners
    • Reselling Examples
    • Documentation
    • Free Websites
  • inputRegister

    Register

    (Buy Domain, Create email)
    (For Hosting Companies)
    By registering, you accept our Terms of Service
    Number of Customers: 1-100
    Number of Customers: 1-100
  • Log in

    Log in

    New user? Create account
    Forgot password?
  • $
  • English
Server Requirements
  • Published websites
  • Site.pro IPs
Builder installation / update
On-Premises
  • Server Requirements
  • Installation
  • CRON
  • Update
  • Migration to version v4
  • Collaboration Service
  • Extra configuration
  • Manual update
  • Changing PHP version
  • Support
Plugin installation
  • Hosting Panel
    • cPanel
    • DirectAdmin
    • Plesk
    • Sentora/ZPanel
    • ISPmanager
    • InterWorx
    • Vesta
    • Hosting Controller
    • CentOS Web Panel
    • Hestia
    • LiveConfig
    • Webuzo
    • Custom hosting (API)
  • Billing Panel
    • WHMCS
    • Blesta
    • Custom billing (API)
API documentation
  • Builder
    • Create session (SSO)
    • Remove existing session
    • Create website backup
    • Restore website backup
  • Templates
    • List template categories
    • List template category tags
    • List templates
    • Get page types available in templates
  • Import
    • Import website
    • Get website import status
    • Import website block
    • Get website block import status
    • Check if imported website is owned by user
  • Websites
    • Create website
    • Modify website
    • Rename website
    • Publish website
    • Edit website pages
    • Edit website settings
    • Delete website
    • Get website template
    • Get website pages
    • Get website variables
    • Get template variables
    • Get website settings
    • Add pages to website
    • Duplicate pages in website
    • Remove pages from website
  • Website Blocks
    • Create empty website
    • Modify website
    • Inspect website
    • Add empty page
    • Modify page
    • Remove page
    • Inspect page
    • Inspect composition
    • Modification descriptor structure by element type
    • Add blocks from compositions
    • Remove blocks
    • Move blocks
    • Modify blocks
    • Inspect block
  • Licenses
    • Get list of published websites
    • Get statistics of publications/openings
    • Block/unblock published website
    • Controlling IP list
    • Read/add/delete hosting plans
  • Integration with your system
    • Allow/disallow domain in builder
    • Check if domains are allowed in builder
  • FAQ
    • Get posts
    • Get categories
Add-ons documentation
  • For Website
    • Public demo URL
    • Editing plans
    • User registration from public demo
    • Website import
  • For Builder
    • Adding custom templates
    • Adding custom builder plugins
    • Scripts
For developers
  • Programming reference
  • Directory structure
  • Meta information (main.json)
  • Frontend logic (main.js)
  • Element template (main.html)
  • Backend logic (main.php)
  • Plugin testing
  • Custom element plugin
  • E-commerce plugin
  • Overriding UI
  • Other examples
Change Log
API documentation → Builder

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

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

[API URL will appear after you log in or sign up]
HTTP Basic
[API Username will appear after you log in or sign up]
[API Password will appear after you log in or sign up]
POST
application/json
application/json

JSON Object Properties:

  • String - domain name used to identify website witch will be backed up (required).
  • String - 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 description object (only on error). Error object structure:
    • Number - error code
    • String - text describing the error

Request example (when storing locally):

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"
}

Response on success (when storing locally) example:

HTTP/1.1 200 OK

Response on success (when downloading) example:

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

[some binary data]

Response on error example:

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

{"error": {"code": 1, "message": "some kind of error message"}}
© Site.pro 2011. Website Builder. United States.
Contact SalesTerms of Service