Home
Version 3
Jobs API

Jobs API

Retrieve Job with known failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/045d9112-bceb-440b-b9d0-109393fb5846

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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMiIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTZ9.tvN8UxnKUqHVdyKQ5qsvDtkVXjyS4VJLiixCjGN1Boc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/045d9112-bceb-440b-b9d0-109393fb5846" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMiIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzUxMDI4NTZ9.tvN8UxnKUqHVdyKQ5qsvDtkVXjyS4VJLiixCjGN1Boc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "045d9112-bceb-440b-b9d0-109393fb5846",
    "created_at": "2015-06-16T23:40:56Z",
    "url": "/v2/jobs/045d9112-bceb-440b-b9d0-109393fb5846"
  },
  "entity": {
    "guid": "045d9112-bceb-440b-b9d0-109393fb5846",
    "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"
    }
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a31444ba-0a03-4ce6-920a-5846d6061c00
Content-Length: 524
X-Content-Type-Options: nosniff