cPanel API 2 Functions - DiskUsage::fetchdiskusage - Knowledgebase

Description

This function retrieves the account's disk usage data.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=DiskUsage&cpanel_jsonapi_func=fetchdiskusage

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Report the raw disk usage

$report_diskusage = $cpanel->api2(

'DiskUsage', 'fetchdiskusage'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Report the raw disk usage

my $report_diskusage = $cpliveapi->api2(

'DiskUsage', 'fetchdiskusage',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username DiskUsage fetchdiskusage

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "fetchdiskusage",
    "data": [
      {
        "owner": "example",
        "usage": 4096,
        "name": "\/home\/example",
        "contents": [
          {
            "owner": "example",
            "usage": 4096,
            "name": ".autorespond",
            "contents": 0,
            "user_contained_usage": 8192,
            "contained_usage": 8192,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".cpaddons",
            "contents": 1,
            "user_contained_usage": 16384,
            "contained_usage": 16384,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".cpanel",
            "contents": 3,
            "user_contained_usage": 2019328,
            "contained_usage": 2019328,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".gem",
            "contents": 1,
            "user_contained_usage": 2035712,
            "contained_usage": 2035712,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".htpasswds",
            "contents": 1,
            "user_contained_usage": 16384,
            "contained_usage": 16384,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".razor",
            "contents": 0,
            "user_contained_usage": 24576,
            "contained_usage": 24576,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".spamassassin",
            "contents": 0,
            "user_contained_usage": 4096,
            "contained_usage": 4096,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".sqmailattach",
            "contents": 0,
            "user_contained_usage": 0,
            "contained_usage": 0,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".sqmaildata",
            "contents": 0,
            "user_contained_usage": 16384,
            "contained_usage": 16384,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": ".trash",
            "contents": 0,
            "user_contained_usage": 0,
            "contained_usage": 0,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "cpanel3-skel",
            "contents": 2,
            "user_contained_usage": 8192,
            "contained_usage": 8192,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "etc",
            "contents": 1,
            "user_contained_usage": 90112,
            "contained_usage": 90112,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "logs",
            "contents": 0,
            "user_contained_usage": 0,
            "contained_usage": 0,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "mail",
            "contents": 7,
            "user_contained_usage": 1110016,
            "contained_usage": 1110016,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "public_ftp",
            "contents": 1,
            "user_contained_usage": 4096,
            "contained_usage": 4096,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "public_html",
            "contents": 4,
            "user_contained_usage": 1994752,
            "contained_usage": 1998848,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "rails_apps",
            "contents": 1,
            "user_contained_usage": 598016,
            "contained_usage": 598016,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "ruby",
            "contents": 3,
            "user_contained_usage": 700416,
            "contained_usage": 700416,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "ssl",
            "contents": 3,
            "user_contained_usage": 45056,
            "contained_usage": 45056,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "thumbs",
            "contents": 1,
            "user_contained_usage": 7225344,
            "contained_usage": 7225344,
            "type": "dir",
            "traversible": 1
          },
          {
            "owner": "example",
            "usage": 4096,
            "name": "tmp",
            "contents": 1,
            "user_contained_usage": 8192,
            "contained_usage": 8192,
            "type": "dir",
            "traversible": 1
          }
        ],
        "user_contained_usage": 16060416,
        "contained_usage": 16064512,
        "type": "dir",
        "traversible": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DiskUsage"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
owner	string	The file object's owner.	A valid string.	example
usage	integer	The file object's size.	A positive integer, in bytes.	4096
name	string	The file object's name.	A valid string.	.autorespond
contents	integer	The count of this file object's contents.	A non-negative integer.	0
user_contained_usage	integer	The file object's size of the file object, in bytes.	A positive integer.	8192
contained_usage	integer	The size of file objects that this file object contains, in bytes.	A positive integer.	8192
type	string	The file object's type.	dir — Directory.	dir
traversible	Boolean	Whether the file object is traverisble.	1 — Traversible. 0 — Nottraversible.	1
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories