luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
open-vault/website/source/api/system/leader.html.md

40 lines
867 B
Markdown
Raw Normal View History

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-15 06:40:33 +00:00
---
/docs/http -> /api
2017-03-17 18:06:03 +00:00
layout: "api"
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-15 06:40:33 +00:00
page_title: "/sys/leader - HTTP API"
sidebar_current: "docs-http-system-leader"
description: |-
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
```json
{
"ha_enabled": true,
"is_self": false,
"leader_address": "https://127.0.0.1:8200/"
}
```