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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NSIsImVtYWlsIjoiZW1haWwtMTg1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDl9.3iEwtILlP5-DIVp_SeZKEYh3t6Mc1V6KVUWqr-WtUn4
Host: example.org
Cookie: 

Route

GET /v2/jobs/7eb20b1d-984e-48c0-ab36-b6906867098a

cURL

curl "https://api.[your-domain.com]/v2/jobs/7eb20b1d-984e-48c0-ab36-b6906867098a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0NSIsImVtYWlsIjoiZW1haWwtMTg1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDl9.3iEwtILlP5-DIVp_SeZKEYh3t6Mc1V6KVUWqr-WtUn4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: edc1d8b1-a96e-462a-9b42-8d1485d4a3b5
Content-Length: 529
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "7eb20b1d-984e-48c0-ab36-b6906867098a",
    "created_at": "2015-01-20T01:52:29+00:00",
    "url": "/v2/jobs/7eb20b1d-984e-48c0-ab36-b6906867098a"
  },
  "entity": {
    "guid": "7eb20b1d-984e-48c0-ab36-b6906867098a",
    "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"
    }
  }
}