consul/website/pages/docs/commands/config/read.mdx

45 lines
957 B
Plaintext
Raw Normal View History

---
2020-04-07 18:55:19 +00:00
layout: docs
page_title: 'Commands: Config Read'
2020-04-07 23:56:08 +00:00
sidebar_title: 'read'
2020-04-07 18:55:19 +00:00
sidebar_current: docs-commands-config-read
---
# Consul Config Read
Command: `consul config read`
The `config read` command reads the config entry specified by the given
kind and name and outputs its JSON representation. See the
2020-04-09 23:46:54 +00:00
[configuration entries docs](/docs/agent/config_entries) for more
details about configuration entries.
## Usage
Usage: `consul config read [options]`
#### API Options
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
#### Enterprise Options
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
#### Config Read Options
2020-04-07 18:55:19 +00:00
- `-kind` - Specifies the kind of the config entry to read.
2020-04-07 18:55:19 +00:00
- `-name` - Specifies the name of the config entry to read.
## Examples
$ consul config read -kind service-defaults -name web
{
"Kind": "service-defaults",
"Name": "web",
"Protocol": "http",
"CreateIndex": 13,
"ModifyIndex": 13
}