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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUyfQ.UQ1Df4L7LGeqVOvEG0HkYPd5kPN5gn2DZOaWoAej8Bs
Host: example.org
Cookie: 

Route

GET /v2/jobs/5d4447ea-d74e-477a-861b-9cad80b94636

cURL

curl "https://api.[your-domain.com]/v2/jobs/5d4447ea-d74e-477a-861b-9cad80b94636" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUyfQ.UQ1Df4L7LGeqVOvEG0HkYPd5kPN5gn2DZOaWoAej8Bs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5ba1726f-93ab-4eb3-a106-871325c2f7eb
Content-Length: 275
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "5d4447ea-d74e-477a-861b-9cad80b94636",
    "created_at": "2014-11-24T19:32:32+00:00",
    "url": "/v2/jobs/5d4447ea-d74e-477a-861b-9cad80b94636"
  },
  "entity": {
    "guid": "5d4447ea-d74e-477a-861b-9cad80b94636",
    "status": "queued"
  }
}