github.com/uchennaokeke444/nomad@v0.11.8/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-session
    31  $ curl \
    32      https://localhost:4646/v1/status/leader
    33  ```
    34  
    35  ### Sample Response
    36  
    37  ```json
    38  "127.0.0.1:4647"
    39  ```
    40  
    41  ## List Peers
    42  
    43  This endpoint returns the set of raft peers in the region.
    44  
    45  | Method | Path            | Produces           |
    46  | ------ | --------------- | ------------------ |
    47  | `GET`  | `/status/peers` | `application/json` |
    48  
    49  The table below shows this endpoint's support for
    50  [blocking queries](/api-docs#blocking-queries) and
    51  [required ACLs](/api-docs#acls).
    52  
    53  | Blocking Queries | ACL Required |
    54  | ---------------- | ------------ |
    55  | `NO`             | `none`       |
    56  
    57  ### Sample Request
    58  
    59  ```shell-session
    60  $ curl \
    61      https://localhost:4646/v1/status/peers
    62  ```
    63  
    64  ### Sample Response
    65  
    66  ```json
    67  ["127.0.0.1:4647"]
    68  ```