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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MSIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjd9.pe8MMlO4dK2XlpPDYr5MkkDh06uDlEsAB0B0nMO6lFo
Host: example.org
Cookie: 

Route

GET /v2/jobs/db81b936-a286-428c-bdd4-102f796b616b

cURL

curl "https://api.[your-domain.com]/v2/jobs/db81b936-a286-428c-bdd4-102f796b616b" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MSIsImVtYWlsIjoiZW1haWwtMTAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjd9.pe8MMlO4dK2XlpPDYr5MkkDh06uDlEsAB0B0nMO6lFo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7628e4f0-5e8b-472a-8f3f-b303477905e1
Content-Length: 524
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "db81b936-a286-428c-bdd4-102f796b616b",
    "created_at": "2015-02-10T01:42:47Z",
    "url": "/v2/jobs/db81b936-a286-428c-bdd4-102f796b616b"
  },
  "entity": {
    "guid": "db81b936-a286-428c-bdd4-102f796b616b",
    "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"
    }
  }
}