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.eyJ1c2VyX2lkIjoidWFhLWlkLTQzIiwiZW1haWwiOiJlbWFpbC0zNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUyfQ.qarwZVTNT9ymGF7JV-_bGILE4A7KnOQ1iSmvR6jOn4o
Host: example.org
Cookie: 

Route

GET /v2/jobs/9b8efa4d-e601-4481-af87-c08b35a16f09

cURL

curl "https://api.[your-domain.com]/v2/jobs/9b8efa4d-e601-4481-af87-c08b35a16f09" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQzIiwiZW1haWwiOiJlbWFpbC0zNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUyfQ.qarwZVTNT9ymGF7JV-_bGILE4A7KnOQ1iSmvR6jOn4o" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 81a43658-b2af-43b8-a2b7-2e31dc56164a
Content-Length: 496
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "9b8efa4d-e601-4481-af87-c08b35a16f09",
    "created_at": "2014-11-24T19:32:32+00:00",
    "url": "/v2/jobs/9b8efa4d-e601-4481-af87-c08b35a16f09"
  },
  "entity": {
    "guid": "9b8efa4d-e601-4481-af87-c08b35a16f09",
    "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
    }
  }
}