CPcpanel
Nova

Return AI App Builder domains

Changed on

This function returns the AI App Builder domains' information for the cPanel account.

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

Request

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

Query parameters

domainstring
Example:example.com

The domain to use for the AI App Builder website. When you specify a domain, the function returns information for that domain only. Otherwise, it returns information for every domain on the 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": "get_all_user_nova_info",
  "module": "Nova",
  "result": {
    "data": [
      {
        "domain": "example.com",
        "metadata": {
          "company": "cPanel",
          "cpanelDomainGUID": "example.com",
          "document_root": "/home/example/public_html",
          "fullcms": 1,
          "language": "en",
          "latest_publish_date": 1706889600,
          "publish_status": 1,
          "session_minted_at": 1706893200,
          "websiteId": 444444
        },
        "quota": {
          "available_space": 1024,
          "can_backup": 1,
          "is_docroot_empty": 1,
          "required_space": 64
        },
        "status": {
          "has_nova_published": 1,
          "has_nova_session": 1,
          "has_nova_website": 1,
          "is_nova": 1,
          "ssl_status": 1
        }
      }
    ],
    "metadata": {
      "main_domain": "example.com",
      "transformed": 1
    },
    "status": 1
  }
}

Changes