Search or ask Docker

Get data usage information

GET /system/df — Docker Engine API 1.57.

View Markdown
GET/system/df

Connection and access

API connection and authentication guidance

/v1.57

No HTTP authentication requirement is declared for this operation. Transport access controls can still apply.

Parameters

type query

Object types, for which to compute and return data.

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "enum": [
    "container",
    "image",
    "volume",
    "build-cache"
  ],
  "type": "string"
}
All schema constraints and annotations
{
  "items": {
    "enum": [
      "container",
      "image",
      "volume",
      "build-cache"
    ],
    "type": "string"
  },
  "type": "array"
}

Serialization: form

verbose query

Show detailed information on space usage.

Type: boolean

All schema constraints and annotations
{
  "default": false,
  "type": "boolean"
}

Request and responses

Response 200

no error

application/json

Type: object

BuildCacheUsage

Schema: BuildCacheDiskUsage

ContainerUsage

Schema: ContainersDiskUsage

ImageUsage

Schema: ImagesDiskUsage

VolumeUsage

Schema: VolumesDiskUsage

All schema constraints and annotations
{
  "properties": {
    "BuildCacheUsage": {
      "$ref": "#/components/schemas/BuildCacheDiskUsage"
    },
    "ContainerUsage": {
      "$ref": "#/components/schemas/ContainersDiskUsage"
    },
    "ImageUsage": {
      "$ref": "#/components/schemas/ImagesDiskUsage"
    },
    "VolumeUsage": {
      "$ref": "#/components/schemas/VolumesDiskUsage"
    }
  },
  "title": "SystemDataUsageResponse",
  "type": "object"
}

Response 200

no error

text/plain

Type: object

BuildCacheUsage

Schema: BuildCacheDiskUsage

ContainerUsage

Schema: ContainersDiskUsage

ImageUsage

Schema: ImagesDiskUsage

VolumeUsage

Schema: VolumesDiskUsage

All schema constraints and annotations
{
  "properties": {
    "BuildCacheUsage": {
      "$ref": "#/components/schemas/BuildCacheDiskUsage"
    },
    "ContainerUsage": {
      "$ref": "#/components/schemas/ContainersDiskUsage"
    },
    "ImageUsage": {
      "$ref": "#/components/schemas/ImagesDiskUsage"
    },
    "VolumeUsage": {
      "$ref": "#/components/schemas/VolumesDiskUsage"
    }
  },
  "title": "SystemDataUsageResponse",
  "type": "object"
}

Response 500

server error

application/json

Schema: ErrorResponse

Schema example

{
  "message": "Something went wrong."
}

Referenced schemas

#/components/schemas/BuildCacheDiskUsage

#/components/schemas/ContainersDiskUsage

#/components/schemas/ErrorResponse

#/components/schemas/ImagesDiskUsage

#/components/schemas/VolumesDiskUsage

Complete operation contract
{
  "operationId": "SystemDataUsage",
  "parameters": [
    {
      "description": "Object types, for which to compute and return data.\n",
      "explode": true,
      "in": "query",
      "name": "type",
      "schema": {
        "items": {
          "enum": [
            "container",
            "image",
            "volume",
            "build-cache"
          ],
          "type": "string"
        },
        "type": "array"
      },
      "style": "form"
    },
    {
      "description": "Show detailed information on space usage.\n",
      "in": "query",
      "name": "verbose",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "BuildCacheUsage": {
                "$ref": "#/components/schemas/BuildCacheDiskUsage"
              },
              "ContainerUsage": {
                "$ref": "#/components/schemas/ContainersDiskUsage"
              },
              "ImageUsage": {
                "$ref": "#/components/schemas/ImagesDiskUsage"
              },
              "VolumeUsage": {
                "$ref": "#/components/schemas/VolumesDiskUsage"
              }
            },
            "title": "SystemDataUsageResponse",
            "type": "object"
          }
        },
        "text/plain": {
          "schema": {
            "properties": {
              "BuildCacheUsage": {
                "$ref": "#/components/schemas/BuildCacheDiskUsage"
              },
              "ContainerUsage": {
                "$ref": "#/components/schemas/ContainersDiskUsage"
              },
              "ImageUsage": {
                "$ref": "#/components/schemas/ImagesDiskUsage"
              },
              "VolumeUsage": {
                "$ref": "#/components/schemas/VolumesDiskUsage"
              }
            },
            "title": "SystemDataUsageResponse",
            "type": "object"
          }
        }
      },
      "description": "no error"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "server error"
    }
  },
  "summary": "Get data usage information",
  "tags": [
    "System"
  ]
}