Home
Version 3
Jobs API

Jobs API

Retrieve Job that was successful

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NCIsImVtYWlsIjoiZW1haWwtMjQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.XUJsk21F2DqgBSNfrKZNXFwia8cGXMckCx-XAiPweuE
Host: example.org
Cookie: 

Route

GET /v2/jobs/fa5123f7-a7e8-4ba7-b7fa-347db2941f00

cURL

curl "https://api.[your-domain.com]/v2/jobs/fa5123f7-a7e8-4ba7-b7fa-347db2941f00" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NCIsImVtYWlsIjoiZW1haWwtMjQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.XUJsk21F2DqgBSNfrKZNXFwia8cGXMckCx-XAiPweuE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0352e778-7854-4c60-be14-b0b3a6a22db0
Content-Length: 167
X-Content-Type-Options: nosniff

Status

200 OK

Body

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