github.com/dkerwin/nomad@v0.3.3-0.20160525181927-74554135514b/website/source/docs/http/nodes.html.md (about) 1 --- 2 layout: "http" 3 page_title: "HTTP API: /v1/nodes" 4 sidebar_current: "docs-http-nodes" 5 description: |- 6 The '/1/nodes' endpoint is used to list the client nodes. 7 --- 8 9 # /v1/nodes 10 11 The `nodes` endpoint is used to query the status of client nodes. 12 By default, the agent's local region is used; another region can 13 be specified using the `?region=` query parameter. 14 15 ## GET 16 17 <dl> 18 <dt>Description</dt> 19 <dd> 20 Lists all the client nodes registered with Nomad. 21 </dd> 22 23 <dt>Method</dt> 24 <dd>GET</dd> 25 26 <dt>URL</dt> 27 <dd>`/v1/nodes`</dd> 28 29 <dt>Parameters</dt> 30 <dd> 31 <ul> 32 <li> 33 <span class="param">prefix</span> 34 <span class="param-flags">optional</span> 35 Filter nodes based on an identifier prefix. 36 </li> 37 </ul> 38 </dd> 39 40 <dt>Blocking Queries</dt> 41 <dd> 42 [Supported](/docs/http/index.html#blocking-queries) 43 </dd> 44 45 <dt>Returns</dt> 46 <dd> 47 48 ```javascript 49 [ 50 { 51 "ID": "c9972143-861d-46e6-df73-1d8287bc3e66", 52 "Datacenter": "dc1", 53 "Name": "web-8e40e308", 54 "NodeClass": "", 55 "Drain": false, 56 "Status": "ready", 57 "StatusDescription": "", 58 "CreateIndex": 3, 59 "ModifyIndex": 4 60 }, 61 ... 62 ] 63 ``` 64 65 </dd> 66 </dl>