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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.dxDBPomXNcomtuGT_OL2MzcAMUtEb0z_kfjTMxgZbuI
Host: example.org
Cookie: 

Route

GET /v2/jobs/89debe82-ad4d-4b5d-9588-d0c40a1c4183

cURL

curl "https://api.[your-domain.com]/v2/jobs/89debe82-ad4d-4b5d-9588-d0c40a1c4183" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.dxDBPomXNcomtuGT_OL2MzcAMUtEb0z_kfjTMxgZbuI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: ba06a47f-00db-4ef5-8cde-8f678c4b2e80
Content-Length: 529
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "89debe82-ad4d-4b5d-9588-d0c40a1c4183",
    "created_at": "2014-11-05T01:02:21+00:00",
    "url": "/v2/jobs/89debe82-ad4d-4b5d-9588-d0c40a1c4183"
  },
  "entity": {
    "guid": "89debe82-ad4d-4b5d-9588-d0c40a1c4183",
    "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"
    }
  }
}