# List configs


[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 /configs`



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



## Parameters

### filters

Location: query. Required: no.

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

Available filters:

- `id=<config id>`
- `label=<key> or label=<key>=value`
- `name=<config name>` matches all or part of a config name (prefix match)


```json
{
  "description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the configs list.\n\nAvailable filters:\n\n- `id=\u003cconfig id\u003e`\n- `label=\u003ckey\u003e or label=\u003ckey\u003e=value`\n- `name=\u003cconfig name\u003e` matches all or part of a config name (prefix match)\n",
  "in": "query",
  "name": "filters",
  "pointer": "/paths/~1configs/get/parameters/0",
  "schema": {
    "type": "string"
  }
}
```

## Request and responses

### Response 200 application/json

no error


Schema:

```json
{
  "example": [
    {
      "CreatedAt": "2016-11-05T01:20:17.327670065Z",
      "ID": "ktnbjxoalbkvbvedmg1urrz8h",
      "Spec": {
        "Name": "server.conf"
      },
      "UpdatedAt": "2016-11-05T01:20:17.327670065Z",
      "Version": {
        "Index": 11
      }
    }
  ],
  "items": {
    "$ref": "#/components/schemas/Config"
  },
  "type": "array"
}
```









Schema example:
```json
[
  {
    "CreatedAt": "2016-11-05T01:20:17.327670065Z",
    "ID": "ktnbjxoalbkvbvedmg1urrz8h",
    "Spec": {
      "Name": "server.conf"
    },
    "UpdatedAt": "2016-11-05T01:20:17.327670065Z",
    "Version": {
      "Index": 11
    }
  }
]
```


### Response 500 application/json

server error


Schema:

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









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


### Response 503 application/json

node is not part of a swarm


Schema:

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









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


## Complete operation contract

```json
{
  "operationId": "ConfigList",
  "parameters": [
    {
      "description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the configs list.\n\nAvailable filters:\n\n- `id=\u003cconfig id\u003e`\n- `label=\u003ckey\u003e or label=\u003ckey\u003e=value`\n- `name=\u003cconfig name\u003e` matches all or part of a config name (prefix match)\n",
      "in": "query",
      "name": "filters",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "example": [
              {
                "CreatedAt": "2016-11-05T01:20:17.327670065Z",
                "ID": "ktnbjxoalbkvbvedmg1urrz8h",
                "Spec": {
                  "Name": "server.conf"
                },
                "UpdatedAt": "2016-11-05T01:20:17.327670065Z",
                "Version": {
                  "Index": 11
                }
              }
            ],
            "items": {
              "$ref": "#/components/schemas/Config"
            },
            "type": "array"
          }
        }
      },
      "description": "no error"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "server error"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "node is not part of a swarm"
    }
  },
  "summary": "List configs",
  "tags": [
    "Config"
  ]
}
```

## Referenced schemas

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

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




