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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMiIsImVtYWlsIjoiZW1haWwtMTQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.9dLNnK6G799wnou36d9FroODOcjFCd4nPeoyWJymzm0
Host: example.org
Cookie: 

Route

GET /v2/jobs/5dac84df-967d-4ef0-8c6d-2f36ad39321c

cURL

curl "https://api.[your-domain.com]/v2/jobs/5dac84df-967d-4ef0-8c6d-2f36ad39321c" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMiIsImVtYWlsIjoiZW1haWwtMTQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.9dLNnK6G799wnou36d9FroODOcjFCd4nPeoyWJymzm0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 51d62321-e4de-4979-bfa9-3f3991107399
Content-Length: 275
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "5dac84df-967d-4ef0-8c6d-2f36ad39321c",
    "created_at": "2014-11-05T01:02:21+00:00",
    "url": "/v2/jobs/5dac84df-967d-4ef0-8c6d-2f36ad39321c"
  },
  "entity": {
    "guid": "5dac84df-967d-4ef0-8c6d-2f36ad39321c",
    "status": "queued"
  }
}