Home
Version 3
Jobs API

Jobs API

Retrieve Job with unknown failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/ff94e815-eef4-4642-bf82-d5c54f091506

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.eyJ1c2VyX2lkIjoidWFhLWlkLTQyOSIsImVtYWlsIjoiZW1haWwtMjkxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3Mjl9.usa1i0NdFJJ1oYrozg1rrf_o-u7pP1VGx3sroaNBdy4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/ff94e815-eef4-4642-bf82-d5c54f091506" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyOSIsImVtYWlsIjoiZW1haWwtMjkxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3Mjl9.usa1i0NdFJJ1oYrozg1rrf_o-u7pP1VGx3sroaNBdy4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "ff94e815-eef4-4642-bf82-d5c54f091506",
    "created_at": "2016-05-12T00:45:29Z",
    "url": "/v2/jobs/ff94e815-eef4-4642-bf82-d5c54f091506"
  },
  "entity": {
    "guid": "ff94e815-eef4-4642-bf82-d5c54f091506",
    "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: 83b377c3-88af-4fc7-8859-a8ce45774d60
Content-Length: 491
X-Content-Type-Options: nosniff