CPcpanel
Nova

Return disk quota information

Changed on

This function checks whether a user has enough 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.

get/Nova/disk_quota_check

Request

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

Query parameters

domainstring
Example:example.com

The domain to check for available disk space.

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": "disk_quota_check",
  "module": "Nova",
  "result": {
    "data": {
      "available_space": 1024,
      "can_backup": 1,
      "is_docroot_empty": 1,
      "required_space": 64
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes