Home
Version 3
Jobs API

Jobs API

Retrieve Job that is queued

GET /v2/jobs/:guid

Fields

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MCIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzB9.yf3sud2MP7ouhjV2wFnO2-l0LMy6YSgXpfSeLVp9CUA
Host: example.org
Cookie: 

Route

GET /v2/jobs/2115de6c-adc6-42b9-94b7-a459ed389523

cURL

curl "https://api.[your-domain.com]/v2/jobs/2115de6c-adc6-42b9-94b7-a459ed389523" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MCIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzB9.yf3sud2MP7ouhjV2wFnO2-l0LMy6YSgXpfSeLVp9CUA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9521ff4b-bcbc-4f15-9d28-17969009a300
Content-Length: 275
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "2115de6c-adc6-42b9-94b7-a459ed389523",
    "created_at": "2014-12-24T01:39:30+00:00",
    "url": "/v2/jobs/2115de6c-adc6-42b9-94b7-a459ed389523"
  },
  "entity": {
    "guid": "2115de6c-adc6-42b9-94b7-a459ed389523",
    "status": "queued"
  }
}