Home
Version 3
Jobs API

Jobs API

Retrieve Job with known failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/e51eccfb-a377-47c0-b370-3fb860e10f7a

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.eyJ1c2VyX2lkIjoidWFhLWlkLTk2IiwiZW1haWwiOiJlbWFpbC02N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzQxfQ.Ykkt9BE7el5bhReG-0LQgp0zVrDay4RrsfO1bbYKDKg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/e51eccfb-a377-47c0-b370-3fb860e10f7a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTk2IiwiZW1haWwiOiJlbWFpbC02N0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2MTg3NzQxfQ.Ykkt9BE7el5bhReG-0LQgp0zVrDay4RrsfO1bbYKDKg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "e51eccfb-a377-47c0-b370-3fb860e10f7a",
    "created_at": "2015-03-05T19:15:41Z",
    "url": "/v2/jobs/e51eccfb-a377-47c0-b370-3fb860e10f7a"
  },
  "entity": {
    "guid": "e51eccfb-a377-47c0-b370-3fb860e10f7a",
    "status": "failed",
    "error": "Use of entity>error is deprecated in favor of entity>error_details.",
    "error_details": {
      "code": 1001,
      "description": "Request invalid due to parse error: arbitrary string",
      "error_code": "CF-MessageParseError"
    }
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: be8bd46d-4c87-4416-99f3-12a321d44eb5
Content-Length: 524
X-Content-Type-Options: nosniff