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

Publish website available since version 4.0.0 / 3.7.350 On-Premises

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-on-premises-builder-domain.com/api/ 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 + publish.

This API is for publishing website. Publishing website consists of 2 or more API calls:
    1) use "Create session" API call with additional parameter more = true to get loginHash and builderApiUrl;
    2) with this API use received loginHash and builderApiUrl + 'publish' (as API URL) to initiate publishing process (when API call returns it only means that publishing has started);
    3) optionally call (same as in step 2) API call with additional parameter progress = true to get publishing progress (when you receive response with complete = true, then publishing process has completed);

http://your-on-premises-builder-domain.com/api/publish (builderApiUrl + "publish")
HTTP Basic
[API Username from brand]
[API Password from brand]
POST
application/json
application/json

JSON request Object Properties:

  • String - login hash you received from "Create session" API call;
  • String - (optional) if set then progress of specified publication process will be returned, otherwise new publication process will be started and its process ID will be returned in the response;
  • String - (optional) template ID, if passed then current template (is exists) will be removed and replaced with this new template (all data will be lost);

JSON response Object Properties:

  • String - (optional) text describing current publish process progress;
  • Number - (optional) numeric value from 0 to 100 to show progress completeness (note publishing consists of multiple actions so this value will go multiple times to 100, so do not rely on it);
  • Boolean - (optional) if true then publishing process is complete;
  • String - (optional) error message, if this parameter is not empty that means publishing process stopped (unless this is authentication error);
  • String - (optional) publication process ID (set only when requested for new publication, that is "processId" property was not set in the request);