CPcpanel
Nova

Return AI App Builder publication process

Changed on

This function polls the publishing progress information.

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/poll_publish

Request

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

Query parameters

file_namestring required
Example:/home/cpuser/logs/nova_publish_2024-02-02T16:46:58.log

The publish process's log file name.

Note:

This is the full path to the log file.

pidinteger required
Example:123456

The publish action's process ID, as returned by the publish function.

Note:

This value must be a positive integer. The system reports is_running as 0 unless this process ID belongs to a running process on this account.

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": "poll_publish",
  "module": "Nova",
  "result": {
    "data": {
      "is_running": 1,
      "log": [
        "Starting publish...",
        "Processing files...",
        "Completed"
      ],
      "progress": 50
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes