status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #676 from ryanbreen/status 

Fixes for docs/agent/http/status
This commit is contained in:
Armon Dadgar 2015-02-06 12:28:08 -08:00
parent 5c2a764cbe 9e54778fbe
commit ad484dc625
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/source/docs/agent/http/status.html.markdown
View File

@ -10,8 +10,10 @@ description: >
# Status HTTP Endpoint
The Status endpoints are used to get information about the status
of the Consul cluster. These are generally very low level, and not really
useful for clients.
of the Consul cluster.
Please note: this information is generally very low level
and not often useful for clients.
The following endpoints are supported:
@ -21,7 +23,7 @@ The following endpoints are supported:
### <a name="status_leader"></a> /v1/status/leader
This endpoint is used to get the Raft leader for the datacenter
the agent is running in. It returns only an address like:
in which the agent is running. It returns an address, such as:
```text
"10.1.10.12:8300"
@ -29,8 +31,8 @@ the agent is running in. It returns only an address like:
### <a name="status_peers"></a> /v1/status/peers
This endpoint is used to get the Raft peers for the datacenter
the agent is running in. It returns a list of addresses like:
This endpoint retrieves the Raft peers for the datacenter in which the
the agent is running. It returns a list of addresses, such as:
```javascript
[