CPcpanel
Nova

Run AI App Builder domain publication

Changed on

This function publishes an AI App Builder website to the document root directory for the selected domain.

Note:

This function requires that your package includes the AI App Builder feature.

Important:

When you disable the AI App Builder feature, the system disables this function.

get/Nova/publish

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

archiveUrlstring required
Example:https://example.com/archive.zip

URL to download the website archive from.

domainstring required
Example:example.com

The domain to use for the AI App Builder website.

signaturestring required
Example:a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Security signature for request validation.

userIdstring required
Example:nova_a1b2c3d4e5f6g7h8

Unique identifier for the website.

cleanupinteger
Example:1

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.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "publish",
  "module": "Nova",
  "result": {
    "data": {
      "file_name": "/home/cpuser/logs/nova_publish_2024-02-02T16:46:58.log",
      "pid": 123456,
      "user": "username"
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes