2019-05-01 18:21:11 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-04-07 18:55:19 +00:00
|
|
|
page_title: 'Commands: Config List'
|
2023-01-26 18:42:13 +00:00
|
|
|
description: >-
|
|
|
|
|
The `consul config list` command lists all configuration entries for each config entry kind.
|
2019-05-01 18:21:11 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Config List
|
|
|
|
|
|
|
|
|
|
Command: `consul config list`
|
|
|
|
|
|
2023-01-25 16:52:43 +00:00
|
|
|
Corresponding HTTP API Endpoint: [\[GET\] /v1/config/:kind](/consul/api-docs/config#list-configurations)
|
2022-01-10 17:40:11 +00:00
|
|
|
|
2019-05-01 18:21:11 +00:00
|
|
|
The `config list` command lists all given config entries of the given kind.
|
2023-01-25 16:52:43 +00:00
|
|
|
See the [configuration entries docs](/consul/docs/agent/config-entries) for more
|
2019-05-08 20:19:37 +00:00
|
|
|
details about configuration entries.
|
2019-05-01 18:21:11 +00:00
|
|
|
|
2023-01-25 16:52:43 +00:00
|
|
|
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
|
|
|
|
|
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
|
2022-01-10 21:44:56 +00:00
|
|
|
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
|
|
|
|
|
2022-01-11 14:41:54 +00:00
|
|
|
| ACL Required<sup>1</sup> |
|
|
|
|
|
| ------------------------------------- |
|
|
|
|
|
| `service:read`<br />`intentions:read` |
|
|
|
|
|
|
|
|
|
|
<sup>1</sup> The ACL required depends on the config entry kind being read:
|
|
|
|
|
|
|
|
|
|
| Config Entry Kind | Required ACL |
|
|
|
|
|
| ------------------- | ----------------- |
|
2023-03-20 16:37:30 +00:00
|
|
|
| api-gateway | `mesh:read` |
|
2022-01-11 14:41:54 +00:00
|
|
|
| ingress-gateway | `service:read` |
|
|
|
|
|
| proxy-defaults | `<none>` |
|
|
|
|
|
| service-defaults | `service:read` |
|
|
|
|
|
| service-intentions | `intentions:read` |
|
|
|
|
|
| service-resolver | `service:read` |
|
|
|
|
|
| service-router | `service:read` |
|
|
|
|
|
| service-splitter | `service:read` |
|
|
|
|
|
| terminating-gateway | `service:read` |
|
2022-01-10 21:44:56 +00:00
|
|
|
|
2019-05-01 18:21:11 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `consul config list [options]`
|
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### Command Options
|
2019-05-01 18:21:11 +00:00
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
- `-kind` - Specifies the kind of the config entry to list.
|
2023-06-12 15:11:36 +00:00
|
|
|
- `-filter` - Specifies an expression to use for filtering the results.
|
2019-05-01 18:21:11 +00:00
|
|
|
|
2020-02-07 20:01:04 +00:00
|
|
|
#### Enterprise Options
|
|
|
|
|
|
2021-12-15 01:55:21 +00:00
|
|
|
@include 'http_api_partition_options.mdx'
|
|
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
@include 'http_api_namespace_options.mdx'
|
2019-05-01 18:21:11 +00:00
|
|
|
|
2022-07-27 06:17:11 +00:00
|
|
|
#### API Options
|
|
|
|
|
|
|
|
|
|
@include 'http_api_options_client.mdx'
|
2019-05-01 18:21:11 +00:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2023-06-12 15:11:36 +00:00
|
|
|
To list all service-defaults config entries:
|
|
|
|
|
|
2019-05-01 18:21:11 +00:00
|
|
|
$ consul config list -kind service-defaults
|
|
|
|
|
billing
|
|
|
|
|
db
|
|
|
|
|
web
|
2023-06-12 15:11:36 +00:00
|
|
|
|
|
|
|
|
The following lists service-defaults with a filter expression:
|
|
|
|
|
|
|
|
|
|
$ consul config list -kind service-defaults -filter 'MutualTLSMode == "permissive"'
|
|
|
|
|
db
|
|
|
|
|
web
|
|
|
|
|
|
