Home
Version 3
Jobs API

Jobs API

Retrieve Job with known failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/6cd6fe6c-c4e6-4203-9dee-a2f01c8a18ce

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.eyJ1c2VyX2lkIjoidWFhLWlkLTY2IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM4NjQxNzg5fQ.PV6D-Xv1Vcyeiw7tgRa62W78Ub-bm1DMSbUbwldYxqc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/6cd6fe6c-c4e6-4203-9dee-a2f01c8a18ce" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY2IiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM4NjQxNzg5fQ.PV6D-Xv1Vcyeiw7tgRa62W78Ub-bm1DMSbUbwldYxqc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "6cd6fe6c-c4e6-4203-9dee-a2f01c8a18ce",
    "created_at": "2015-07-27T22:43:09Z",
    "url": "/v2/jobs/6cd6fe6c-c4e6-4203-9dee-a2f01c8a18ce"
  },
  "entity": {
    "guid": "6cd6fe6c-c4e6-4203-9dee-a2f01c8a18ce",
    "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: df879a4e-6955-48d7-a716-46afad6b4168
Content-Length: 524
X-Content-Type-Options: nosniff