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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0IiwiZW1haWwiOiJlbWFpbC0zN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk3fQ.92LSVjiI-eUuLNtsuXdgfq0ehxkt0YN_ba593Hn6E-M
Host: example.org
Cookie: 

Route

GET /v2/jobs/e6cb0538-1072-4834-95a9-b41587c71d37

cURL

curl "https://api.[your-domain.com]/v2/jobs/e6cb0538-1072-4834-95a9-b41587c71d37" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0IiwiZW1haWwiOiJlbWFpbC0zN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk3fQ.92LSVjiI-eUuLNtsuXdgfq0ehxkt0YN_ba593Hn6E-M" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: cdab8fbd-fb56-4782-93ad-d1772518b995
Content-Length: 275
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "e6cb0538-1072-4834-95a9-b41587c71d37",
    "created_at": "2014-11-13T23:38:17+00:00",
    "url": "/v2/jobs/e6cb0538-1072-4834-95a9-b41587c71d37"
  },
  "entity": {
    "guid": "e6cb0538-1072-4834-95a9-b41587c71d37",
    "status": "queued"
  }
}