Home
Version 3
Jobs API

Jobs API

Retrieve Job with known failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/5be55169-29af-4753-a743-91244a81f9c5

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOCIsImVtYWlsIjoiZW1haWwtMzE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NTR9.1qc08TNhxLhZYNzq1x8FxkWEN14pP8kbTM19d3dphUU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/5be55169-29af-4753-a743-91244a81f9c5" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQxOCIsImVtYWlsIjoiZW1haWwtMzE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NTR9.1qc08TNhxLhZYNzq1x8FxkWEN14pP8kbTM19d3dphUU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "5be55169-29af-4753-a743-91244a81f9c5",
    "created_at": "2016-03-14T22:30:54Z",
    "url": "/v2/jobs/5be55169-29af-4753-a743-91244a81f9c5"
  },
  "entity": {
    "guid": "5be55169-29af-4753-a743-91244a81f9c5",
    "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: 
Content-Length: 524
X-Content-Type-Options: nosniff