github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9f7afb56b2'
${ noResults }
consul/website/source/api/status.html.md

2.8 KiB
Raw Blame History

layout page_title sidebar_current description
api Status - HTTP API api-status The /status endpoints return information about the status of the Consul cluster. This information is generally very low level and not often useful for clients.

Status HTTP API

The /status endpoints return information about the status of the Consul cluster. This information is generally very low level and not often useful for clients.

Get Raft Leader

This endpoint returns the Raft leader for the datacenter in which the agent is running.

Method Path Produces
GET /status/leader application/json

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

Blocking Queries Consistency Modes Agent Caching ACL Required
NO none none none

Parameters

  • dc (string: "") - Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter.

Sample Request

$ curl http://127.0.0.1:8500/v1/status/leader

Sample Response

"10.1.10.12:8300"

List Raft Peers

This endpoint retrieves the Raft peers for the datacenter in which the the agent is running. This list of peers is strongly consistent and can be useful in determining when a given server has successfully joined the cluster.

Method Path Produces
GET /status/peers application/json

The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.

Blocking Queries Consistency Modes Agent Caching ACL Required
NO none none none

Parameters

  • dc (string: "") - Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter.

Sample Request

$ curl http://127.0.0.1:8500/v1/status/peers

Sample Response

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