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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NiIsImVtYWlsIjoiZW1haWwtMTg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDl9.L76FZF21-8qZwQ9FCHk_L7SrYsASjlq-EbMC5T9To8s
Host: example.org
Cookie: 

Route

GET /v2/jobs/71bf6f74-8796-4969-8bb7-1b9982995a3c

cURL

curl "https://api.[your-domain.com]/v2/jobs/71bf6f74-8796-4969-8bb7-1b9982995a3c" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NiIsImVtYWlsIjoiZW1haWwtMTg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDl9.L76FZF21-8qZwQ9FCHk_L7SrYsASjlq-EbMC5T9To8s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4dbfd201-f3ce-4b53-90cf-61b873099e83
Content-Length: 275
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "71bf6f74-8796-4969-8bb7-1b9982995a3c",
    "created_at": "2015-01-20T01:52:29+00:00",
    "url": "/v2/jobs/71bf6f74-8796-4969-8bb7-1b9982995a3c"
  },
  "entity": {
    "guid": "71bf6f74-8796-4969-8bb7-1b9982995a3c",
    "status": "queued"
  }
}