# Nova

The Nova module for UAPI.

## Return Nova account status

 - [GET /Nova/account_exists](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-account_exists.md): This function returns whether the cPanel user has been provisioned on the AI App Builder (Nova), that is, whether the cPanel user file carries a Nova API token.

Notes:

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

## Add an existing AI App Builder API token

 - [GET /Nova/add_api_token](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-add_api_token.md): This function adds an existing AI App Builder API token to a cPanel user.

Notes:

  * This function requires that your package includes the AI App Builder feature.
  * You can create an AI App Builder API token with the Nova::create_account function.

Important:

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

## Return domain creation availability

 - [GET /Nova/can_create_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-can_create_domains.md): This function returns whether a cPanel account can create new subdomains or addon domains.

Notes:

  * This function requires that your package includes the AI App Builder feature.
  * Creating a new addon domain depends on the creation of subdomains. If the cPanel account has reached its limit for subdomains, you cannot create a new addon domain.

Important:

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

## Create AI App Builder API key

 - [GET /Nova/create_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-create_account.md): This function creates an AI App Builder API token for a 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.

## Return disk quota information

 - [GET /Nova/disk_quota_check](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-disk_quota_check.md): This function checks whether a user has sufficient free space to back up the domain's document root.

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.

## Return Nova account SSO URL

 - [GET /Nova/ensure_account](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-ensure_account.md): This function ensures that an AI App Builder account exists for the
caller, then returns an SSO URL. The system reuses existing accounts.
For entitled accounts of any tier, the system usually provisions the
account eagerly, asynchronously, during account creation or package
upgrades. This function is a fail-safe: it provisions the account on
the spot for any entitled caller the eager provisioning hasn't
already covered.

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.

## Return AI App Builder domains

 - [GET /Nova/get_all_user_nova_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-get_all_user_nova_info.md): 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.

## Return AI App Builder SSO URL

 - [GET /Nova/get_sso_link](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-get_sso_link.md): This function returns an AI App Builder website's SSO URL.

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.

## Return the user's Nova tier snapshot

 - [GET /Nova/get_tier](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-get_tier.md): This function returns the cPanel user's AI App Builder (Nova) tier snapshot for tier display and upsell.

Notes:

  * This function requires that your package includes the AI App Builder feature.
  * The Meridian theme gates the Nova interface on the nova feature itself; this read-only call only feeds tier-aware display.

## Return AI App Builder publication process

 - [GET /Nova/poll_publish](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-poll_publish.md): 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.

## Run AI App Builder domain publication

 - [GET /Nova/publish](https://api.docs.cpanel.net/specifications/cpanel.openapi/nova/nova-publish.md): 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.