Home
Version 3
Jobs API

Jobs API

Retrieve Job with known failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/0b67c0f9-65f7-4bc0-b0fd-823ab72cfe98

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.eyJ1c2VyX2lkIjoidWFhLWlkLTciLCJlbWFpbCI6ImVtYWlsLTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyOTAzODY5Nn0.FOGqahOCj3qsQ_z91UUWDBfS2cWuHnOLIch6WvamJP4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/0b67c0f9-65f7-4bc0-b0fd-823ab72cfe98" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTciLCJlbWFpbCI6ImVtYWlsLTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyOTAzODY5Nn0.FOGqahOCj3qsQ_z91UUWDBfS2cWuHnOLIch6WvamJP4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "0b67c0f9-65f7-4bc0-b0fd-823ab72cfe98",
    "created_at": "2015-04-07T19:11:36Z",
    "url": "/v2/jobs/0b67c0f9-65f7-4bc0-b0fd-823ab72cfe98"
  },
  "entity": {
    "guid": "0b67c0f9-65f7-4bc0-b0fd-823ab72cfe98",
    "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: 0a5ecc44-1738-48ea-94cf-64325bc1c014
Content-Length: 524
X-Content-Type-Options: nosniff