Home
Version 3
Jobs API

Jobs API

Retrieve Job with unknown 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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MyIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.aEvZSYKjTvBf31aLsSA-lV9dUV99LZctLbzw1dEudUk
Host: example.org
Cookie: 

Route

GET /v2/jobs/e698e983-d04f-4d9d-8b3b-7dd072be9bb3

cURL

curl "https://api.[your-domain.com]/v2/jobs/e698e983-d04f-4d9d-8b3b-7dd072be9bb3" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MyIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.aEvZSYKjTvBf31aLsSA-lV9dUV99LZctLbzw1dEudUk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a5f7d99a-95ad-4546-9394-33ec67edd4e0
Content-Length: 491
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "e698e983-d04f-4d9d-8b3b-7dd072be9bb3",
    "created_at": "2015-02-13T22:35:07Z",
    "url": "/v2/jobs/e698e983-d04f-4d9d-8b3b-7dd072be9bb3"
  },
  "entity": {
    "guid": "e698e983-d04f-4d9d-8b3b-7dd072be9bb3",
    "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
    }
  }
}