Publish Sitejet domain

This function publishes a domain's Sitejet website.

SecurityBasicAuth
Request
query Parameters
domain
required
string

The domain for the Sitejet website.

Example: domain=example.com
cleanup
integer

Whether to cleanup the domain's document_root directory during the publication process.

  • 1 — Remove previous files in domain's document_root directory during the publication process.
  • 0 — Do not remove any files in domain's document_root directory during the publication process.
Example: cleanup=1
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Sitejet/start_publish
Request samples
uapi --output=jsonpretty \
  --user=username \
  Sitejet \
  start_publish \
  domain='example.com'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "start_publish",
  • "module": "Sitejet",
  • "result": {
    • "data": {
      • "file_name": "/home/cpuser/logs/publish_2024-02-02T16:46:58.log",
      • "pid": 123456
      },
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}