A new platform for documentation and tutorials is launching soon.

We are migrating Nomad documentation into HashiCorp Developer, our new developer experience.

Join Now
Type '/' to Search

»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.

MethodPathProduces
GET/status/leaderapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
NOnone

»Sample Request

$ curl \
    https://localhost:4646/v1/status/leader

$ curl \
    https://localhost:4646/v1/status/leader

»Sample Response

"127.0.0.1:4647"

"127.0.0.1:4647"

»List Peers

This endpoint returns the set of raft peers in the region.

MethodPathProduces
GET/status/peersapplication/json

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking QueriesACL Required
NOnone

»Sample Request

$ curl \
    https://localhost:4646/v1/status/peers

$ curl \
    https://localhost:4646/v1/status/peers

»Sample Response

["127.0.0.1:4647"]

["127.0.0.1:4647"]