github.com/dkerwin/nomad@v0.3.3-0.20160525181927-74554135514b/website/source/docs/http/jobs.html.md (about) 1 --- 2 layout: "http" 3 page_title: "HTTP API: /v1/jobs" 4 sidebar_current: "docs-http-jobs" 5 description: |- 6 The '/1/jobs' endpoint is used list jobs and register new ones. 7 --- 8 9 # /v1/jobs 10 11 The `jobs` endpoint is used to query the status of existing jobs in Nomad 12 and to register new jobs. By default, the agent's local region is used; 13 another region can be specified using the `?region=` query parameter. 14 15 ## GET 16 17 <dl> 18 <dt>Description</dt> 19 <dd> 20 Lists all the jobs registered with Nomad. 21 </dd> 22 23 <dt>Method</dt> 24 <dd>GET</dd> 25 26 <dt>URL</dt> 27 <dd>`/v1/jobs`</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 jobs 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": "binstore-storagelocker", 52 "Name": "binstore-storagelocker", 53 "Type": "service", 54 "Priority": 50, 55 "Status": "", 56 "StatusDescription": "", 57 "CreateIndex": 14, 58 "ModifyIndex": 14 59 }, 60 ... 61 ] 62 ``` 63 64 </dd> 65 </dl> 66 67 ## PUT / POST 68 69 <dl> 70 <dt>Description</dt> 71 <dd> 72 Registers a new job. 73 </dd> 74 75 <dt>Method</dt> 76 <dd>PUT or POST</dd> 77 78 <dt>URL</dt> 79 <dd>`/v1/jobs`</dd> 80 81 <dt>Parameters</dt> 82 <dd> 83 <ul> 84 <li> 85 <span class="param">Job</span> 86 <span class="param-flags">required</span> 87 The JSON definition of the job. The general structure is given 88 by the [job specification](/docs/jobspec/json.html). 89 </li> 90 </ul> 91 </dd> 92 <dt>Returns</dt> 93 <dd> 94 95 ```javascript 96 { 97 "EvalID": "d092fdc0-e1fd-2536-67d8-43af8ca798ac", 98 "EvalCreateIndex": 35, 99 "JobModifyIndex": 34, 100 } 101 ``` 102 103 </dd> 104 </dl>