Disk usage

Get server disk usage and total storage space available.

  • HTTP Method: GET
  • URL: https://example.domain.tld/api/v1/server/disk/usage/
  • Require authentication: Yes
  • Permission level required: MasterAdmin

Response parameters

Parameter Type Description
total_storage_gb float Total storage space in GB
usage_gb float Usage in GB
usage_kb float Usage in KB
usage_mb float Usage in MB

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/server/disk/usage/"
r = requests.get(url, auth=("admin","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)

{'total_storage_gb': 1000.0,
 'usage_gb': 180.06,
 'usage_kb': 180062944.0,
 'usage_mb': 180062.94}