Sign in
Jobs

Retrieve information for specific job_id

get/jobs/{job_id}

Request

  • Base URL: http://localhost/v2
  • URL: http://localhost/v2/jobs/{job_id}
  • Auth: HTTP bearer

Path parameters

job_idinteger required

job_id to query

Response

Success

idinteger required
status'pending' | 'queued' | 'running' | 'cancelled' | 'successful' | 'failed' | 'unknown' required
descriptionstring required
numStepsinteger required

Example response

{
  "description": "Installation of FLECS App 1 (1.2.3.4-f1)",
  "numSteps": 5,
  "currentStep": {
    "description": "Downloading...",
    "num": 3,
    "unitsTotal": 10485761,
    "unitsDone": 5120000,
    "rate": 2048
  },
  "result": {
    "code": -1,
    "message": "Explanation what went wrong"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.