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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OSIsImVtYWlsIjoiZW1haWwtMTAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjd9.nb8lZYY3Trlolr_J17cLf7yFCp-Ixt7siMMkkAD-JrE
Host: example.org
Cookie: 

Route

GET /v2/jobs/731ec4e4-e323-4898-be11-5ca65bd94668

cURL

curl "https://api.[your-domain.com]/v2/jobs/731ec4e4-e323-4898-be11-5ca65bd94668" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0OSIsImVtYWlsIjoiZW1haWwtMTAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjd9.nb8lZYY3Trlolr_J17cLf7yFCp-Ixt7siMMkkAD-JrE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e93878c2-d010-4cff-a2aa-6a5efccc1ead
Content-Length: 270
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "731ec4e4-e323-4898-be11-5ca65bd94668",
    "created_at": "2015-02-10T01:42:47Z",
    "url": "/v2/jobs/731ec4e4-e323-4898-be11-5ca65bd94668"
  },
  "entity": {
    "guid": "731ec4e4-e323-4898-be11-5ca65bd94668",
    "status": "queued"
  }
}