Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - quota_enabled - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - quota_enabled
Skip to end of metadata
Go to start of metadata

Description

This function checks if quotas are enabled on at least one of a user's /home directory mounts.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/quota_enabled?api.version=1
 Command Line
whmapi1 quota_enabled 


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data": {
      "quota_enabled": 0
   },
   "metadata": {
      "command": "quota_enabled",
      "reason": "OK",
      "result": 1,
      "version": 1
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
quota_enabledBooleanWhether quotas are enabled.
  • 1 — Enabled.
  • 0 — Disabled.
0