# cPanel API 2 Functions - DiskUsage::fetchdiskusage

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function retrieves the account's disk usage data.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:
When you disable the [*File Storage* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


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

// Report the raw disk usage
$report_diskusage = $cpanel->api2(
    'DiskUsage', 'fetchdiskusage'
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


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

# Report the raw disk usage
my $report_diskusage = $cpliveapi->api2(
    'DiskUsage', 'fetchdiskusage',
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username DiskUsage fetchdiskusage
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
owner
td
em
string
td
The file object's owner.
td
A valid string.
td
code
example
tr
td
code
usage
td
em
integer
td
The file object's size.
td
A positive integer, in bytes.
td
code
4096
tr
td
code
name
td
em
string
td
The file object's name.
td
A valid string.
td
code
.autorespond
tr
td
code
contents
td
em
integer
td
The count of this file object's contents.
td
A non-negative integer.
td
code
0
tr
td
code
user_contained_usage
td
em
integer
td
The file object's size of the file object, in bytes.
td
A positive integer.
td
code
8192
tr
td
code
contained_usage
td
em
integer
td
The size of file objects that this file object contains, in bytes.
td
A positive integer.
td
code
8192
tr
td
code
type
td
em
string
td
The file object's type.
td
ul
li
code
dir
 — Directory.
td
code
dir
tr
td
code
traversible
td
em
Boolean
td
Whether the file object is traverisble.
td
ul
li
code
1
 — Traversible.
li
code
0
 — 
strong
Not
 traversible.
td
code
1
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
span
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1