github.com/outbrain/consul@v1.4.5/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 return information about the status of the Consul
     7    cluster. This information is generally very low level and not often useful for
     8    clients.
     9  ---
    10  
    11  # Status HTTP API
    12  
    13  The `/status` endpoints return information about the status of the Consul
    14  cluster. This information is generally very low level and not often useful for
    15  clients.
    16  
    17  ## Get Raft Leader
    18  
    19  This endpoint returns the Raft leader for the datacenter in which the agent is
    20  running.
    21  
    22  | Method | Path                         | Produces               |
    23  | :----- | :--------------------------- | ---------------------- |
    24  | `GET`  | `/status/leader`             | `application/json`         |
    25  
    26  The table below shows this endpoint's support for
    27  [blocking queries](/api/index.html#blocking-queries),
    28  [consistency modes](/api/index.html#consistency-modes),
    29  [agent caching](/api/index.html#agent-caching), and
    30  [required ACLs](/api/index.html#acls).
    31  
    32  | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
    33  | ---------------- | ----------------- | ------------- | ------------ |
    34  | `NO`             | `none`            | `none`        | `none`       |
    35  
    36  ### Sample Request
    37  
    38  ```text
    39  $ curl http://127.0.0.1:8500/v1/status/leader
    40  ```
    41  
    42  ### Sample Response
    43  
    44  ```json
    45  "10.1.10.12:8300"
    46  ```
    47  
    48  ## List Raft Peers
    49  
    50  This endpoint retrieves the Raft peers for the datacenter in which the the agent
    51  is running. This list of peers is strongly consistent and can be useful in
    52  determining when a given server has successfully joined the cluster.
    53  
    54  | Method | Path                         | Produces               |
    55  | :----- | :--------------------------- | ---------------------- |
    56  | `GET`  | `/status/peers`              | `application/json`         |
    57  
    58  The table below shows this endpoint's support for
    59  [blocking queries](/api/index.html#blocking-queries),
    60  [consistency modes](/api/index.html#consistency-modes),
    61  [agent caching](/api/index.html#agent-caching), and
    62  [required ACLs](/api/index.html#acls).
    63  
    64  | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
    65  | ---------------- | ----------------- | ------------- | ------------ |
    66  | `NO`             | `none`            | `none`        | `none`       |
    67  
    68  ### Sample Request
    69  
    70  ```text
    71  $ curl http://127.0.0.1:8500/v1/status/peers
    72  ```
    73  
    74  ### Sample Response
    75  
    76  ```json
    77  [
    78    "10.1.10.12:8300",
    79    "10.1.10.11:8300",
    80    "10.1.10.10:8300"
    81  ]
    82  ```