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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MiIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.HmBugoAG0zAnh4wVUWBMMsFowB1cdMkpv0RqcxOKG9I
Host: example.org
Cookie: 

Route

GET /v2/jobs/adf2d719-5f91-4831-946d-2a48d83f40d0

cURL

curl "https://api.[your-domain.com]/v2/jobs/adf2d719-5f91-4831-946d-2a48d83f40d0" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MiIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.HmBugoAG0zAnh4wVUWBMMsFowB1cdMkpv0RqcxOKG9I" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 240df7a2-5e68-4be8-8a05-f9f45fcd4472
Content-Length: 270
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "adf2d719-5f91-4831-946d-2a48d83f40d0",
    "created_at": "2015-02-13T22:35:07Z",
    "url": "/v2/jobs/adf2d719-5f91-4831-946d-2a48d83f40d0"
  },
  "entity": {
    "guid": "adf2d719-5f91-4831-946d-2a48d83f40d0",
    "status": "queued"
  }
}