---
title: "Return server's drive partition information"
method: GET
path: "/getdiskusage"
tags: ["Server Administration", "System Information"]
---

# Return server's drive partition information

`GET /getdiskusage`

This function retrieves the server's drive partition information.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `partition` object[] — An array of objects that contain drive partition information.
      - `available` integer — The partition's unused disk space, measured in kilobytes.
      - `device` string — The partition's device name.
      - `disk` string — The partition's label.
      - `filesystem` string — The partition's absolute directory path.
      - `inodes_available` integer — The number of unused inodes on the partition.
      - `inodes_ipercentage` integer — The percentage of the partition's total
      - `inodes_total` integer — The total number of inodes that the partition will allow.
      - `inodes_used` integer — The number of inodes used on the partition.
      - `mount` string — The partition's mount point.
      - `percentage` integer — The percentage of the partition's total disk space used.
      - `total` integer — The partition's total allocated disk space, measured in kilobytes.
      - `used` integer — The partition's disk space used, measured in kilobytes.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)