open-nomad/website/source/api/status.html.md
2017-05-30 20:25:10 -04:00

1.8 KiB

layout page_title sidebar_current description
api Status - HTTP API api-status 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, consistency modes, and required ACLs.

Blocking Queries Consistency Modes ACL Required
NO all none

Sample Request

$ curl \
    https://nomad.rocks/v1/status/leader

Sample Response

"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, consistency modes, and required ACLs.

Blocking Queries Consistency Modes ACL Required
NO all none

Sample Request

$ curl \
    https://nomad.rocks/v1/status/peers

Sample Response

[
  "127.0.0.1:4647"
]