Home
Version 3
Jobs API

Jobs API

Retrieve Job that is queued

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/4dc690d1-fbf0-40c1-afc4-0fd6da7225b4

Body

Name Description Default Valid Values Example Values
guid The guid of the job.
status The status of the job.
  • failed
  • finished
  • queued
  • running

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyNyIsImVtYWlsIjoiZW1haWwtMjg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3Mjl9.VEKFipQJWPjCkwall5yPIdt4w2aOlSuZFaH7qHyCSlM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/4dc690d1-fbf0-40c1-afc4-0fd6da7225b4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyNyIsImVtYWlsIjoiZW1haWwtMjg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3Mjl9.VEKFipQJWPjCkwall5yPIdt4w2aOlSuZFaH7qHyCSlM" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "4dc690d1-fbf0-40c1-afc4-0fd6da7225b4",
    "created_at": "2016-05-12T00:45:29Z",
    "url": "/v2/jobs/4dc690d1-fbf0-40c1-afc4-0fd6da7225b4"
  },
  "entity": {
    "guid": "4dc690d1-fbf0-40c1-afc4-0fd6da7225b4",
    "status": "queued"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f90bea43-90a9-4d59-8f49-eaeaf900428f
Content-Length: 270
X-Content-Type-Options: nosniff