Home
Version 3
Jobs API

Jobs API

Retrieve Job with known failure

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQzIiwiZW1haWwiOiJlbWFpbC0zNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk3fQ.-hYbjFYEvLxdbOsx3Kb7fzD1ofpH2-SLRs2svsbsXT8
Host: example.org
Cookie: 

Route

GET /v2/jobs/46bfdf12-0c92-4934-ad0b-5866a743fba7

cURL

curl "https://api.[your-domain.com]/v2/jobs/46bfdf12-0c92-4934-ad0b-5866a743fba7" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQzIiwiZW1haWwiOiJlbWFpbC0zNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk3fQ.-hYbjFYEvLxdbOsx3Kb7fzD1ofpH2-SLRs2svsbsXT8" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e35bdf08-7f42-4554-b34b-6bccc85a53d4
Content-Length: 529
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "46bfdf12-0c92-4934-ad0b-5866a743fba7",
    "created_at": "2014-11-13T23:38:17+00:00",
    "url": "/v2/jobs/46bfdf12-0c92-4934-ad0b-5866a743fba7"
  },
  "entity": {
    "guid": "46bfdf12-0c92-4934-ad0b-5866a743fba7",
    "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"
    }
  }
}