REST-API: Jobs
Erzeugt aus dem OpenAPI-Dokument des Daemons. Konventionen, Anmeldung, der CSRF-Header und der WebSocket stehen unter API.
GET /api/jobs
Abschnitt betitelt „GET /api/jobs“The signed-in user’s 100 most recent jobs, newest first. Finished jobs are kept for 7 days. Live progress comes on the topic jobs/{id}.
Antworten
- 200:
application/json: Job[]
Jeder Fehler antwortet mit Problem Details (application/problem+json) und einem stabilen Code aus der Fehlerreferenz.
GET /api/jobs/{id}
Abschnitt betitelt „GET /api/jobs/{id}“A job of the signed-in user; administrators can read every job. Others get 404 jobs.job.not_found.
Parameter
| Name | Ort | Typ | Pflicht | Beschreibung |
|---|---|---|---|---|
id |
path | integer (int64) | ja |
Antworten
- 200:
application/json: Job
Jeder Fehler antwortet mit Problem Details (application/problem+json) und einem stabilen Code aus der Fehlerreferenz.
POST /api/jobs/{id}/cancel
Abschnitt betitelt „POST /api/jobs/{id}/cancel“Cancels a queued job right away and asks a running one to stop; it ends as cancelled once its work gives up. Cancelling a finished job changes nothing.
Parameter
| Name | Ort | Typ | Pflicht | Beschreibung |
|---|---|---|---|---|
id |
path | integer (int64) | ja |
Antworten
- 204
Jeder Fehler antwortet mit Problem Details (application/problem+json) und einem stabilen Code aus der Fehlerreferenz.