Jobs API

Retrieve Job with unknown failure

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/4bede831-cfb4-4231-b173-c3fc2167588f

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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNiIsImVtYWlsIjoiZW1haWwtODFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4OH0.3T8YuTMLESTmJn8zTdu0tM60puQGaHw4f-kBQFhR8zg
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/jobs/4bede831-cfb4-4231-b173-c3fc2167588f" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNiIsImVtYWlsIjoiZW1haWwtODFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4OH0.3T8YuTMLESTmJn8zTdu0tM60puQGaHw4f-kBQFhR8zg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "4bede831-cfb4-4231-b173-c3fc2167588f",
    "created_at": "2016-06-08T16:41:28Z",
    "url": "/v2/jobs/4bede831-cfb4-4231-b173-c3fc2167588f"
  },
  "entity": {
    "guid": "4bede831-cfb4-4231-b173-c3fc2167588f",
    "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: 56414eb5-39a8-4d6f-a2cd-d5009ee0dbc4
Content-Length: 491
X-Content-Type-Options: nosniff