System

Get data usage information

Changed on
get/system/df

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Query parameters

typestring[]

Object types, for which to compute and return data.

verboseboolean

Show detailed information on space usage.

Response

no error

Example response

{
  "ImageUsage": {
    "ActiveCount": 1,
    "TotalCount": 4,
    "Reclaimable": 12345678,
    "TotalSize": 98765432
  },
  "ContainerUsage": {
    "ActiveCount": 1,
    "TotalCount": 4,
    "Reclaimable": 12345678,
    "TotalSize": 98765432
  },
  "VolumeUsage": {
    "ActiveCount": 1,
    "TotalCount": 4,
    "Reclaimable": 12345678,
    "TotalSize": 98765432
  },
  "BuildCacheUsage": {
    "ActiveCount": 1,
    "TotalCount": 4,
    "Reclaimable": 12345678,
    "TotalSize": 98765432
  }
}

Changes