Home
Version 3
Jobs API

Jobs API

Retrieve Job that is queued

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/2a9aeabc-fc20-471a-837b-545e30d6dac8

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.eyJ1c2VyX2lkIjoidWFhLWlkLTY5IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM4NjQxNzkwfQ.3_N6WT6aH__Z1lh-W4niEvncjZgHqeE4fo5BADUdgqQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/2a9aeabc-fc20-471a-837b-545e30d6dac8" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY5IiwiZW1haWwiOiJlbWFpbC00OUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM4NjQxNzkwfQ.3_N6WT6aH__Z1lh-W4niEvncjZgHqeE4fo5BADUdgqQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "2a9aeabc-fc20-471a-837b-545e30d6dac8",
    "created_at": "2015-07-27T22:43:10Z",
    "url": "/v2/jobs/2a9aeabc-fc20-471a-837b-545e30d6dac8"
  },
  "entity": {
    "guid": "2a9aeabc-fc20-471a-837b-545e30d6dac8",
    "status": "queued"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c0ed9c0f-3edd-44a6-bf04-70bbfb1720fb
Content-Length: 270
X-Content-Type-Options: nosniff