github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
consul/website/source/docs/agent/http/status.html.markdown

1.2 KiB
Raw Blame History

layout page_title sidebar_current description
docs Status (HTTP) docs-agent-http-status The Status endpoints are used to get information about the status of the Consul cluster.

Status HTTP Endpoint

The Status endpoints are used to get information about the status of the Consul cluster.

Please note: this information is generally very low level and not often useful for clients.

The following endpoints are supported:

/v1/status/leader

This endpoint is used to get the Raft leader for the datacenter in which the agent is running. It returns an address, such as:

"10.1.10.12:8300"

/v1/status/peers

This endpoint retrieves the Raft peers for the datacenter in which the the agent is running. It returns a list of addresses, such as:

[
  "10.1.10.12:8300",
  "10.1.10.11:8300",
  "10.1.10.10:8300"
]

This list of peers is strongly consistent and can be useful in determining when a given server has successfully joined the cluster.