github.com/iqoqo/nomad@v0.11.3-0.20200911112621-d7021c74d101/website/pages/api-docs/status.mdx (about)

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