Home
Version 3
Jobs API

Jobs API

Retrieve Job with unknown failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/23b1c0dd-033f-4b13-8a86-915431cfa6a4

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNCIsImVtYWlsIjoiZW1haWwtMzAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMjN9.i7R-ze05xSygP_r36JuLQ_8kdnNaWFhVW0jnsk0wHjo
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/23b1c0dd-033f-4b13-8a86-915431cfa6a4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQwNCIsImVtYWlsIjoiZW1haWwtMzAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMjN9.i7R-ze05xSygP_r36JuLQ_8kdnNaWFhVW0jnsk0wHjo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "23b1c0dd-033f-4b13-8a86-915431cfa6a4",
    "created_at": "2015-06-04T00:05:23Z",
    "url": "/v2/jobs/23b1c0dd-033f-4b13-8a86-915431cfa6a4"
  },
  "entity": {
    "guid": "23b1c0dd-033f-4b13-8a86-915431cfa6a4",
    "status": "failed",
    "error": "Use of entity>error is deprecated in favor of entity>error_details.",
    "error_details": {
      "error_code": "UnknownError",
      "description": "An unknown error occurred.",
      "code": 10001
    }
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bd5df01f-1080-447c-aed7-f62000028cdf
Content-Length: 491
X-Content-Type-Options: nosniff