list.mdx

layout	page_title	description
commands	Commands: Config List	The `consul config list` command lists all configuration entries for each config entry kind.

Consul Config List

Command: consul config list

Corresponding HTTP API Endpoint: [GET] /v1/config/:kind

The config list command lists all given config entries of the given kind. See the configuration entries docs for more details about configuration entries.

The table below shows this command's required ACLs. Configuration of blocking queries and agent caching are not supported from commands, but may be from the corresponding HTTP endpoint.

ACL Required1
service:read intentions:read

¹ The ACL required depends on the config entry kind being read:

Config Entry Kind	Required ACL
api-gateway	mesh:read
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

Usage

Usage: consul config list [options]

Command Options

• -kind - Specifies the kind of the config entry to list.
• -filter - Specifies an expression to use for filtering the results.

Enterprise Options

@include 'http_api_partition_options.mdx'

@include 'http_api_namespace_options.mdx'

API Options

@include 'http_api_options_client.mdx'

Examples

To list all service-defaults config entries:

$ consul config list -kind service-defaults
billing
db
web

The following lists service-defaults with a filter expression:

$ consul config list -kind service-defaults -filter 'MutualTLSMode == "permissive"'
db
web