# List Images


[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 /images/json`

Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.

## 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/images/json'
```



## Parameters

### all

Location: query. Required: no.

Show all images. Only images from a final layer (no children) are shown by default.

```json
{
  "description": "Show all images. Only images from a final layer (no children) are shown by default.",
  "in": "query",
  "name": "all",
  "pointer": "/paths/~1images~1json/get/parameters/0",
  "schema": {
    "default": false,
    "type": "boolean"
  }
}
```

### filters

Location: query. Required: no.

A JSON encoded value of the filters (a `map[string][]string`) to
process on the images list.

Available filters:

- `before`=(`<image-name>[:<tag>]`,  `<image id>` or `<image@digest>`)
- `dangling=true`
- `label=key` or `label="key=value"` of an image label
- `reference`=(`<image-name>[:<tag>]`)
- `since`=(`<image-name>[:<tag>]`,  `<image id>` or `<image@digest>`)
- `until=<timestamp>`


```json
{
  "description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the images list.\n\nAvailable filters:\n\n- `before`=(`\u003cimage-name\u003e[:\u003ctag\u003e]`,  `\u003cimage id\u003e` or `\u003cimage@digest\u003e`)\n- `dangling=true`\n- `label=key` or `label=\"key=value\"` of an image label\n- `reference`=(`\u003cimage-name\u003e[:\u003ctag\u003e]`)\n- `since`=(`\u003cimage-name\u003e[:\u003ctag\u003e]`,  `\u003cimage id\u003e` or `\u003cimage@digest\u003e`)\n- `until=\u003ctimestamp\u003e`\n",
  "in": "query",
  "name": "filters",
  "pointer": "/paths/~1images~1json/get/parameters/1",
  "schema": {
    "type": "string"
  }
}
```

### shared-size

Location: query. Required: no.

Compute and show shared size as a `SharedSize` field on each image.

```json
{
  "description": "Compute and show shared size as a `SharedSize` field on each image.",
  "in": "query",
  "name": "shared-size",
  "pointer": "/paths/~1images~1json/get/parameters/2",
  "schema": {
    "default": false,
    "type": "boolean"
  }
}
```

### digests

Location: query. Required: no.

Show digest information as a `RepoDigests` field on each image.

```json
{
  "description": "Show digest information as a `RepoDigests` field on each image.",
  "in": "query",
  "name": "digests",
  "pointer": "/paths/~1images~1json/get/parameters/3",
  "schema": {
    "default": false,
    "type": "boolean"
  }
}
```

### manifests

Location: query. Required: no.

Include `Manifests` in the image summary.

```json
{
  "description": "Include `Manifests` in the image summary.",
  "in": "query",
  "name": "manifests",
  "pointer": "/paths/~1images~1json/get/parameters/4",
  "schema": {
    "default": false,
    "type": "boolean"
  }
}
```

### identity

Location: query. Required: no.

Include `Identity` in each manifest summary. Requires `manifests=1`.

```json
{
  "description": "Include `Identity` in each manifest summary. Requires `manifests=1`.",
  "in": "query",
  "name": "identity",
  "pointer": "/paths/~1images~1json/get/parameters/5",
  "schema": {
    "default": false,
    "type": "boolean"
  }
}
```

## Request and responses

### Response 200 application/json

Summary image data for the images matching the query


Schema:

```json
{
  "items": {
    "$ref": "#/components/schemas/ImageSummary"
  },
  "type": "array"
}
```










### Response 500 application/json

server error


Schema:

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









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


## Complete operation contract

```json
{
  "description": "Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.",
  "operationId": "ImageList",
  "parameters": [
    {
      "description": "Show all images. Only images from a final layer (no children) are shown by default.",
      "in": "query",
      "name": "all",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the images list.\n\nAvailable filters:\n\n- `before`=(`\u003cimage-name\u003e[:\u003ctag\u003e]`,  `\u003cimage id\u003e` or `\u003cimage@digest\u003e`)\n- `dangling=true`\n- `label=key` or `label=\"key=value\"` of an image label\n- `reference`=(`\u003cimage-name\u003e[:\u003ctag\u003e]`)\n- `since`=(`\u003cimage-name\u003e[:\u003ctag\u003e]`,  `\u003cimage id\u003e` or `\u003cimage@digest\u003e`)\n- `until=\u003ctimestamp\u003e`\n",
      "in": "query",
      "name": "filters",
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Compute and show shared size as a `SharedSize` field on each image.",
      "in": "query",
      "name": "shared-size",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "description": "Show digest information as a `RepoDigests` field on each image.",
      "in": "query",
      "name": "digests",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "description": "Include `Manifests` in the image summary.",
      "in": "query",
      "name": "manifests",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "description": "Include `Identity` in each manifest summary. Requires `manifests=1`.",
      "in": "query",
      "name": "identity",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "items": {
              "$ref": "#/components/schemas/ImageSummary"
            },
            "type": "array"
          }
        }
      },
      "description": "Summary image data for the images matching the query"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "server error"
    }
  },
  "summary": "List Images",
  "tags": [
    "Image"
  ]
}
```

## Referenced schemas

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

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




