Jobs

PreviousApps NextOverview

Last updated 16 days ago

Was this helpful?

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

get

/jobs

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/jobs'

200

[
  {
    "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"
    }
  }
]

Success

Retrieve information for specific job_id

get

/jobs/{job_id}

Path parameters

job_idintegerrequired

job_id to query

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost/v2/jobs/{job_id}'

200

404

{
  "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"
  }
}

Success

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

delete

/jobs/{job_id}

Path parameters

job_idintegerrequired

job_id to query

Responses

text/plain

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost/v2/jobs/{job_id}'

200

400

404

No body

Success