github.com/dkerwin/nomad@v0.3.3-0.20160525181927-74554135514b/website/source/docs/http/agent-servers.html.md (about) 1 --- 2 layout: "http" 3 page_title: "HTTP API: /v1/agent/servers" 4 sidebar_current: "docs-http-agent-servers" 5 description: |- 6 The '/v1/agent/servers' endpoint is used to query and update the servers list. 7 --- 8 9 # /v1/agent/servers 10 11 The `servers` endpoint is used to query an agent in client mode for its list 12 of known servers. Client nodes register themselves with these server addresses 13 so that they may dequeue work. The `servers` endpoint can be used to keep this 14 configuration up to date if there are changes in the cluster. 15 16 ## GET 17 18 <dl> 19 <dt>Description</dt> 20 <dd> 21 Lists the known server nodes. 22 </dd> 23 24 <dt>Method</dt> 25 <dd>GET</dd> 26 27 <dt>URL</dt> 28 <dd>`/v1/agent/servers`</dd> 29 30 <dt>Parameters</dt> 31 <dd> 32 None 33 </dd> 34 35 <dt>Returns</dt> 36 <dd> 37 38 ```javascript 39 [ 40 "server1.local:4647", 41 "server2.local:4647" 42 ] 43 ``` 44 45 </dd> 46 </dl> 47 48 ## PUT / POST 49 50 <dl> 51 <dt>Description</dt> 52 <dd> 53 Updates the list of known servers to the provided list. Replaces 54 all previous server addresses with the new list. 55 </dd> 56 57 <dt>Method</dt> 58 <dd>PUT or POST</dd> 59 60 <dt>URL</dt> 61 <dd>`/v1/agent/servers`</dd> 62 63 <dt>Parameters</dt> 64 <dd> 65 <ul> 66 <li> 67 <span class="param">address</span> 68 <span class="param-flags">required</span> 69 The address of a server node in host:port format. This 70 parameter may be specified multiple times to configure 71 multiple servers on the client. 72 </li> 73 </ul> 74 </dd> 75 76 <dt>Returns</dt> 77 <dd> 78 A 200 status code on success. 79 </dd> 80 </dl> 81 82