# Get data usage information


[API catalog](/reference/api/) · [Docker Engine overview](/reference/api/engine/version/v1.57/) · [Product manual](https://docs.docker.com/engine/) · [OpenAPI specification](/reference/api/engine/version/v1.57.yaml)

API version: 1.57





`GET /system/df`



## Connection and access

[API connection and authentication guidance](/reference/api/engine/version/v1.57/#connection)


Server: `/v1.57`

Effective security: alternatives are OR; schemes within an alternative are AND. An empty array declares no HTTP authentication requirement.

```json
null
```

## Example request

Replace placeholders and provide the required credentials or request body.

```console
curl \
  --request GET \
  --unix-socket "${DOCKER_SOCKET:-/var/run/docker.sock}" \
  --header 'Accept: application/json' \
  'http://localhost/v1.57/system/df'
```



## Parameters

### type

Location: query. Required: no.

Object types, for which to compute and return data.


```json
{
  "description": "Object types, for which to compute and return data.\n",
  "explode": true,
  "in": "query",
  "name": "type",
  "pointer": "/paths/~1system~1df/get/parameters/0",
  "schema": {
    "items": {
      "enum": [
        "container",
        "image",
        "volume",
        "build-cache"
      ],
      "type": "string"
    },
    "type": "array"
  },
  "style": "form"
}
```

### verbose

Location: query. Required: no.

Show detailed information on space usage.


```json
{
  "description": "Show detailed information on space usage.\n",
  "in": "query",
  "name": "verbose",
  "pointer": "/paths/~1system~1df/get/parameters/1",
  "schema": {
    "default": false,
    "type": "boolean"
  }
}
```

## Request and responses

### Response 200 application/json

no error


Schema:

```json
{
  "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 text/plain

no error


Schema:

```json
{
  "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 application/json

server error


Schema:

```json
{
  "$ref": "#/components/schemas/ErrorResponse"
}
```









Schema example:
```json
{
  "message": "Something went wrong."
}
```


## Complete operation contract

```json
{
  "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"
  ]
}
```

## Referenced schemas

- [#/components/schemas/BuildCacheDiskUsage](/reference/api/engine/version/v1.57/schemas/BuildCacheDiskUsage/)

- [#/components/schemas/ContainersDiskUsage](/reference/api/engine/version/v1.57/schemas/ContainersDiskUsage/)

- [#/components/schemas/ErrorResponse](/reference/api/engine/version/v1.57/schemas/ErrorResponse/)

- [#/components/schemas/ImagesDiskUsage](/reference/api/engine/version/v1.57/schemas/ImagesDiskUsage/)

- [#/components/schemas/VolumesDiskUsage](/reference/api/engine/version/v1.57/schemas/VolumesDiskUsage/)




