HEhexlet
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

  • 6df97b60796cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api tag System added

    • info

      added the non-success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      for the query request parameter verbose, default value false was removed

    • info

      api tag System removed

    • info

      query request parameter type list-of-types was widened by adding types string

    • info

      for the query request parameter type, the type was generalized from array to no type

    • info

      removed the non-success response with the status