Jobs

Retrieve a list of all pending/queued/running/failed/cancelled jobs

get

Responses

application/json

object[]Optional

get

HTTPcURLJavaScriptPython

GET /v2/jobs HTTP/1.1
Host: localhost
Accept: */*

200

Success

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

Retrieve information for specific job_id

get

Path parameters

job_idintegerRequired

job_id to query

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /v2/jobs/{job_id} HTTP/1.1
Host: localhost
Accept: */*

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

Cancel job or remove failed/successful/cancelled job from journal

delete

Path parameters

job_idintegerRequired

job_id to query

Responses

text/plain

delete

HTTPcURLJavaScriptPython

DELETE /v2/jobs/{job_id} HTTP/1.1
Host: localhost
Accept: */*

No content