72 lines
1.6 KiB
Markdown
72 lines
1.6 KiB
Markdown
---
|
|
layout: api
|
|
page_title: Status - HTTP API
|
|
sidebar_current: api-status
|
|
description: |-
|
|
The /status endpoints query the Nomad system status.
|
|
---
|
|
|
|
# Status HTTP API
|
|
|
|
The `/status` endpoints query the Nomad system status.
|
|
|
|
## Read Leader
|
|
|
|
This endpoint returns the address of the current leader in the region.
|
|
|
|
| Method | Path | Produces |
|
|
| ------ | ---------------------------- | -------------------------- |
|
|
| `GET` | `/status/leader` | `application/json` |
|
|
|
|
The table below shows this endpoint's support for
|
|
[blocking queries](/api/index.html#blocking-queries) and
|
|
[required ACLs](/api/index.html#acls).
|
|
|
|
| Blocking Queries | ACL Required |
|
|
| ---------------- | ------------ |
|
|
| `NO` | `none` |
|
|
|
|
### Sample Request
|
|
|
|
```text
|
|
$ curl \
|
|
https://localhost:4646/v1/status/leader
|
|
```
|
|
|
|
### Sample Response
|
|
|
|
```json
|
|
"127.0.0.1:4647"
|
|
```
|
|
|
|
## List Peers
|
|
|
|
This endpoint returns the set of raft peers in the region.
|
|
|
|
| Method | Path | Produces |
|
|
| ------ | ---------------------------- | -------------------------- |
|
|
| `GET` | `/status/peers` | `application/json` |
|
|
|
|
The table below shows this endpoint's support for
|
|
[blocking queries](/api/index.html#blocking-queries) and
|
|
[required ACLs](/api/index.html#acls).
|
|
|
|
| Blocking Queries | ACL Required |
|
|
| ---------------- | ------------ |
|
|
| `NO` | `none` |
|
|
|
|
### Sample Request
|
|
|
|
```text
|
|
$ curl \
|
|
https://localhost:4646/v1/status/peers
|
|
```
|
|
|
|
### Sample Response
|
|
|
|
```json
|
|
[
|
|
"127.0.0.1:4647"
|
|
]
|
|
```
|