Home
Version 3
Jobs API

Jobs API

Retrieve Job that is queued

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/aaf7ab50-aa44-4e8d-a2d2-3f2002ac0aab

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MSIsImVtYWlsIjoiZW1haWwtMjgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5Njl9.ZmZAGfoXX9No5G-D93iX3yEy8GU5RNJ93LgDh2EKk_4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/aaf7ab50-aa44-4e8d-a2d2-3f2002ac0aab" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MSIsImVtYWlsIjoiZW1haWwtMjgzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5Njl9.ZmZAGfoXX9No5G-D93iX3yEy8GU5RNJ93LgDh2EKk_4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "aaf7ab50-aa44-4e8d-a2d2-3f2002ac0aab",
    "created_at": "2015-10-15T23:52:49Z",
    "url": "/v2/jobs/aaf7ab50-aa44-4e8d-a2d2-3f2002ac0aab"
  },
  "entity": {
    "guid": "aaf7ab50-aa44-4e8d-a2d2-3f2002ac0aab",
    "status": "queued"
  }
}

Headers

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