Home
Version 3
Jobs API

Jobs API

Retrieve Job that is queued

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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMSIsImVtYWlsIjoiZW1haWwtMTUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzJ9.R-Qm3t7KOO3qslAMwEe7yB0fbbgNvVxYzxc9HArxUTc
Host: example.org
Cookie: 

Route

GET /v2/jobs/9a66c913-3e38-4a4a-8c24-008668fa41c7

cURL

curl "https://api.[your-domain.com]/v2/jobs/9a66c913-3e38-4a4a-8c24-008668fa41c7" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMSIsImVtYWlsIjoiZW1haWwtMTUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzJ9.R-Qm3t7KOO3qslAMwEe7yB0fbbgNvVxYzxc9HArxUTc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8119479b-747b-481a-af76-b692f879bd9d
Content-Length: 270
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "9a66c913-3e38-4a4a-8c24-008668fa41c7",
    "created_at": "2015-02-12T01:42:12Z",
    "url": "/v2/jobs/9a66c913-3e38-4a4a-8c24-008668fa41c7"
  },
  "entity": {
    "guid": "9a66c913-3e38-4a4a-8c24-008668fa41c7",
    "status": "queued"
  }
}