github.com/kardianos/nomad@v0.1.3-0.20151022182107-b13df73ee850/website/source/docs/http/allocs.html.md (about) 1 --- 2 layout: "http" 3 page_title: "HTTP API: /v1/allocations" 4 sidebar_current: "docs-http-allocs" 5 description: |- 6 The '/1/allocations' endpoint is used to list the allocations. 7 --- 8 9 # /v1/allocations 10 11 The `allocations` endpoint is used to query the status of allocations. 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 allocations. 21 </dd> 22 23 <dt>Method</dt> 24 <dd>GET</dd> 25 26 <dt>URL</dt> 27 <dd>`/v1/allocations`</dd> 28 29 <dt>Parameters</dt> 30 <dd> 31 None 32 </dd> 33 34 <dt>Returns</dt> 35 <dd> 36 37 ```javascript 38 [ 39 { 40 "ID": "3575ba9d-7a12-0c96-7b28-add168c67984", 41 "EvalID": "151accaa-1ac6-90fe-d427-313e70ccbb88", 42 "Name": "binstore-storagelocker.binsl[3]", 43 "NodeID": "c9972143-861d-46e6-df73-1d8287bc3e66", 44 "JobID": "binstore-storagelocker", 45 "TaskGroup": "binsl", 46 "DesiredStatus": "run", 47 "DesiredDescription": "", 48 "ClientStatus": "running", 49 "ClientDescription": "", 50 "CreateIndex": 16, 51 "ModifyIndex": 16 52 }, 53 ... 54 ] 55 ``` 56 57 </dd> 58 </dl> 59