Home
Version 3
Jobs API

Jobs API

Retrieve Job that is queued

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/4e1da283-bcd9-441d-934e-d6d69db47061

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1NCIsImVtYWlsIjoiZW1haWwtMzI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyODd9.2gZX3cREb-xi38XpSfOqv4PS03E2Zl-kNyuWVq6EQ4U
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/4e1da283-bcd9-441d-934e-d6d69db47061" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1NCIsImVtYWlsIjoiZW1haWwtMzI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyODd9.2gZX3cREb-xi38XpSfOqv4PS03E2Zl-kNyuWVq6EQ4U" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "4e1da283-bcd9-441d-934e-d6d69db47061",
    "created_at": "2016-01-19T19:41:27Z",
    "url": "/v2/jobs/4e1da283-bcd9-441d-934e-d6d69db47061"
  },
  "entity": {
    "guid": "4e1da283-bcd9-441d-934e-d6d69db47061",
    "status": "queued"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 270
X-Content-Type-Options: nosniff