2017-05-26 23:17:33 +00:00
|
|
|
---
|
|
|
|
|
layout: api
|
|
|
|
|
page_title: Status - HTTP API
|
2020-02-06 23:45:31 +00:00
|
|
|
sidebar_title: Status
|
|
|
|
|
description: The /status endpoints query the Nomad system status.
|
2017-05-26 23:17:33 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| ------ | ---------------- | ------------------ |
|
|
|
|
|
| `GET` | `/status/leader` | `application/json` |
|
2017-05-26 23:17:33 +00:00
|
|
|
|
|
|
|
|
The table below shows this endpoint's support for
|
2020-02-06 23:45:31 +00:00
|
|
|
[blocking queries](/api#blocking-queries) and
|
|
|
|
|
[required ACLs](/api#acls).
|
2017-05-26 23:17:33 +00:00
|
|
|
|
2017-05-31 00:31:16 +00:00
|
|
|
| Blocking Queries | ACL Required |
|
|
|
|
|
| ---------------- | ------------ |
|
|
|
|
|
| `NO` | `none` |
|
2017-05-26 23:17:33 +00:00
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
```shell
|
2017-05-26 23:17:33 +00:00
|
|
|
$ curl \
|
2018-01-29 16:27:52 +00:00
|
|
|
https://localhost:4646/v1/status/leader
|
2017-05-26 23:17:33 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
"127.0.0.1:4647"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## List Peers
|
|
|
|
|
|
|
|
|
|
This endpoint returns the set of raft peers in the region.
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| ------ | --------------- | ------------------ |
|
|
|
|
|
| `GET` | `/status/peers` | `application/json` |
|
2017-05-26 23:17:33 +00:00
|
|
|
|
|
|
|
|
The table below shows this endpoint's support for
|
2020-02-06 23:45:31 +00:00
|
|
|
[blocking queries](/api#blocking-queries) and
|
|
|
|
|
[required ACLs](/api#acls).
|
2017-05-26 23:17:33 +00:00
|
|
|
|
2017-05-31 00:31:16 +00:00
|
|
|
| Blocking Queries | ACL Required |
|
|
|
|
|
| ---------------- | ------------ |
|
|
|
|
|
| `NO` | `none` |
|
2017-05-26 23:17:33 +00:00
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-02-06 23:45:31 +00:00
|
|
|
```shell
|
2017-05-26 23:17:33 +00:00
|
|
|
$ curl \
|
2018-01-29 16:27:52 +00:00
|
|
|
https://localhost:4646/v1/status/peers
|
2017-05-26 23:17:33 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
2020-02-06 23:45:31 +00:00
|
|
|
["127.0.0.1:4647"]
|
2017-05-26 23:17:33 +00:00
|
|
|
```
|
