CPcpanel
Bandwidth and Disk Quotas

Return all cPanel accounts disk usage

This function lists the disk usage status of the system's user accounts. This also lists information about file system object (inode) usage.

get/get_disk_usage

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

cache_mode'on' | 'off'
Example:on

Each cPanel & WHM server maintains a cache of users’ disk quota usage. This parameter controls the way this function will use that cache.

  • on - Use the quota cache. This is fast, but it may be inaccurate.
  • off - Ignore the quota cache. This is slower, but it will be more accurate.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "accounts": [
      {
        "blocks_used": 2632,
        "inodes_limit": 9999,
        "inodes_used": 340,
        "user": "username"
      }
    ]
  },
  "metadata": {
    "command": "get_disk_usage",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.