github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/api-docs/status.mdx (about)

     1  ---
     2  layout: api
     3  page_title: Status - HTTP API
     4  description: The /status endpoints query the Nomad system status.
     5  ---
     6  
     7  # Status HTTP API
     8  
     9  The `/status` endpoints query the Nomad system status.
    10  
    11  ## Read Leader
    12  
    13  This endpoint returns the address of the current leader in the region.
    14  
    15  | Method | Path             | Produces           |
    16  | ------ | ---------------- | ------------------ |
    17  | `GET`  | `/status/leader` | `application/json` |
    18  
    19  The table below shows this endpoint's support for
    20  [blocking queries](/api-docs#blocking-queries) and
    21  [required ACLs](/api-docs#acls).
    22  
    23  | Blocking Queries | ACL Required |
    24  | ---------------- | ------------ |
    25  | `NO`             | `none`       |
    26  
    27  ### Sample Request
    28  
    29  ```shell-session
    30  $ curl \
    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-session
    59  $ curl \
    60      https://localhost:4646/v1/status/peers
    61  ```
    62  
    63  ### Sample Response
    64  
    65  ```json
    66  ["127.0.0.1:4647"]
    67  ```