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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNyIsImVtYWlsIjoiZW1haWwtMTc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzZ9.oARBLhmrwmb2BrhMFFk6vJJD9VV8jiVeYP3UXUl2f2M
Host: example.org
Cookie: 

Route

GET /v2/jobs/59d2c12a-ebcf-4fba-8c48-fb87f2793f7d

cURL

curl "https://api.[your-domain.com]/v2/jobs/59d2c12a-ebcf-4fba-8c48-fb87f2793f7d" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzNyIsImVtYWlsIjoiZW1haWwtMTc4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzZ9.oARBLhmrwmb2BrhMFFk6vJJD9VV8jiVeYP3UXUl2f2M" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8a0bd58b-1c21-44ab-9cc4-b9c74a7a7ea5
Content-Length: 524
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "59d2c12a-ebcf-4fba-8c48-fb87f2793f7d",
    "created_at": "2015-01-27T19:14:36Z",
    "url": "/v2/jobs/59d2c12a-ebcf-4fba-8c48-fb87f2793f7d"
  },
  "entity": {
    "guid": "59d2c12a-ebcf-4fba-8c48-fb87f2793f7d",
    "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"
    }
  }
}