Server Requirements
Builder installation / update
On-Premises
Plugin installation
API documentation
Add-ons documentation
For developers
Change Log
API documentation → Import

Import website available since version 4.0.0 / 3.7.312 On-Premises

This API action allows to import website to the builder without any user interaction.

Import limits specified in maxPages, maxFiles, maxGallerySize, maxImageSize, maxDocumentSize are capped at limits set by Site.pro. For example setting maxPages to 1000 will still be reduced to 20 unless we had this limit increased.

Please be aware that once import is successfully complete old website is fully replaced with imported one.

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore [API URL will appear after you <a href="javascript:void(0)" class="btn-login-trigger">log in</a> or <a href="javascript:void(0)" class="btn-register-trigger">sign up</a>] in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/import-begin.

[API URL will appear after you or sign up] (builderApiUrl + "website/import-begin")
HTTP Basic
[API Username will appear after you or sign up]
[API Password will appear after you or sign up]
POST
application/json
application/json

JSON request Object Properties:

  • String - login hash you received from "Create session" API call;
  • String - URL of a website to import;
  • Number - (optional) maximum number of pages that import service can try to import from the website (defaults to 20 unless increased by Site.pro);
  • Number - (optional) maximum number of files that can be downloaded into media library (defaults to 1000 unless increased by Site.pro);
  • Number - (optional) maximum bytes that are allowed to be imported into media library (defaults to 52428800 [50MB] unless increased by Site.pro);
  • Number - (optional) maximum bytes allowed for image files (jpg, png, gif) (defaults to 3145728 [3MB] unless increased by Site.pro);
  • Number - (optional) maximum bytes allowed for files other than images (defaults to 20971520 [20MB] unless increased by Site.pro);
  • Boolean - (optional) tells import service whether "Auto Layout" mode should be enabled on imported website (defaults to true);

JSON response Object Properties:

  • Boolean - (optional) returned on success, contains value true, indicates successfully executed action;
  • String - (optional) returned on success, contains import task ID that must be used with "Get website import status" API call;
  • String - (optional) returned on error, contains error message, indicates failure to execute action;