open-consul/website/pages/docs/commands/config/read.html.md.erb

44 lines
976 B
Plaintext
Raw Normal View History

---
layout: "docs"
page_title: "Commands: Config Read"
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
[configuration entries docs](/docs/agent/config_entries.html) for more
details about configuration entries.
## Usage
Usage: `consul config read [options]`
#### API Options
<%= partial "docs/commands/http_api_options_client" %>
#### Enterprise Options
<%= partial "docs/commands/http_api_namespace_options" %>
#### Config Read Options
* `-kind` - Specifies the kind of the config entry to read.
* `-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
}