github.com/smintz/nomad@v0.8.3/website/source/api/status.html.md (about)

     1  ---
     2  layout: api
     3  page_title: Status - HTTP API
     4  sidebar_current: api-status
     5  description: |-
     6    The /status endpoints query the Nomad system status.
     7  ---
     8  
     9  # Status HTTP API
    10  
    11  The `/status` endpoints query the Nomad system status.
    12  
    13  ## Read Leader
    14  
    15  This endpoint returns the address of the current leader in the region.
    16  
    17  | Method | Path                         | Produces                   |
    18  | ------ | ---------------------------- | -------------------------- |
    19  | `GET`  | `/status/leader`             | `application/json`         |
    20  
    21  The table below shows this endpoint's support for
    22  [blocking queries](/api/index.html#blocking-queries) and
    23  [required ACLs](/api/index.html#acls).
    24  
    25  | Blocking Queries | ACL Required |
    26  | ---------------- | ------------ |
    27  | `NO`             | `none`       |
    28  
    29  ### Sample Request
    30  
    31  ```text
    32  $ curl \
    33      https://localhost:4646/v1/status/leader
    34  ```
    35  
    36  ### Sample Response
    37  
    38  ```json
    39  "127.0.0.1:4647"
    40  ```
    41  
    42  ## List Peers
    43  
    44  This endpoint returns the set of raft peers in the region.
    45  
    46  | Method | Path                         | Produces                   |
    47  | ------ | ---------------------------- | -------------------------- |
    48  | `GET`  | `/status/peers`              | `application/json`         |
    49  
    50  The table below shows this endpoint's support for
    51  [blocking queries](/api/index.html#blocking-queries) and
    52  [required ACLs](/api/index.html#acls).
    53  
    54  | Blocking Queries | ACL Required |
    55  | ---------------- | ------------ |
    56  | `NO`             | `none`       |
    57  
    58  ### Sample Request
    59  
    60  ```text
    61  $ curl \
    62      https://localhost:4646/v1/status/peers
    63  ```
    64  
    65  ### Sample Response
    66  
    67  ```json
    68  [
    69    "127.0.0.1:4647"
    70  ]
    71  ```