Home
Version 3
Jobs API

Jobs API

Retrieve Job that was successful

GET /v2/jobs/:guid

Request

Route

GET /v2/jobs/3718b68d-302f-4ae4-8964-e874d3641a19

Body

Name Description Default Valid Values Example Values
guid The guid of the job.
status The status of the job.
  • failed
  • finished
  • queued
  • running

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNCIsImVtYWlsIjoiZW1haWwtMjI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDl9.HdE68lUunLPxigXQ8XjOsHmzDB1Tb7wZBdShjLM6QrE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/jobs/3718b68d-302f-4ae4-8964-e874d3641a19" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNCIsImVtYWlsIjoiZW1haWwtMjI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDl9.HdE68lUunLPxigXQ8XjOsHmzDB1Tb7wZBdShjLM6QrE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "0",
    "created_at": "1970-01-01T00:00:00Z",
    "url": "/v2/jobs/0"
  },
  "entity": {
    "guid": "0",
    "status": "finished"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: b9d94c59-cb6c-4963-a2f0-849119144769
Content-Length: 167
X-Content-Type-Options: nosniff