open-vault/website/source/docs/http/system/leader.html.md
Seth Vargo 19b2b049c3
Redo docs for system backend
This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.
2017-03-16 09:46:49 -07:00

868 B

layout page_title sidebar_current description
http /sys/leader - HTTP API docs-http-system-leader The `/sys/leader` endpoint is used to check the high availability status and current leader of Vault.

/sys/leader

The /sys/leader endpoint is used to check the high availability status and current leader of Vault.

Read Leader Status

This endpoint returns the high availability status and current leader instance of Vault.

Method Path Produces
GET /sys/leader 200 application/json

Sample Request

$ curl \
    https://vault.rocks/v1/sys/leader

Sample Response

{
  "ha_enabled": true,
  "is_self": false,
  "leader_address": "https://127.0.0.1:8200/"
}