open-nomad/website/source/docs/http/nodes.html.md

1.2 KiB

layout page_title sidebar_current description
http HTTP API: /v1/nodes docs-http-nodes The '/1/nodes' endpoint is used to list the client nodes.

/v1/nodes

The nodes endpoint is used to query the status of client nodes. By default, the agent's local region is used; another region can be specified using the ?region= query parameter.

GET

Description
Lists all the client nodes registered with Nomad.
Method
GET
URL
`/v1/nodes`
Parameters
  • prefix optional Filter nodes based on an identifier prefix.
Blocking Queries
[Supported](/docs/http/index.html#blocking-queries)
Returns
```javascript
[
{
    "ID": "c9972143-861d-46e6-df73-1d8287bc3e66",
    "Datacenter": "dc1",
    "Name": "web-8e40e308",
    "NodeClass": "",
    "Drain": false,
    "Status": "ready",
    "StatusDescription": "",
    "CreateIndex": 3,
    "ModifyIndex": 4
},
...
]
```