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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzJ9._B9aFLme2a8mkvnfAupwLL0DPaVvvGqzGGqR9BzW8cU
Host: example.org
Cookie: 

Route

GET /v2/jobs/f4d02cf3-1f62-45ed-b779-490ab0015cf0

cURL

curl "https://api.[your-domain.com]/v2/jobs/f4d02cf3-1f62-45ed-b779-490ab0015cf0" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzJ9._B9aFLme2a8mkvnfAupwLL0DPaVvvGqzGGqR9BzW8cU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 45b5c999-03ca-41b1-8a3c-60976d8d8ee1
Content-Length: 524
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "f4d02cf3-1f62-45ed-b779-490ab0015cf0",
    "created_at": "2015-02-12T01:42:12Z",
    "url": "/v2/jobs/f4d02cf3-1f62-45ed-b779-490ab0015cf0"
  },
  "entity": {
    "guid": "f4d02cf3-1f62-45ed-b779-490ab0015cf0",
    "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"
    }
  }
}