Skip to content
Odysseus/docs

Jobs and scheduled work

Work that runs to completion rather than staying up: one-off jobs, their runs, and the schedules that create them.

Every address below is served under the control plane’s base URL. Permission is the guard the route is registered with; who holds it is read from the control plane’s own grant, so it cannot drift from what the server does. A dash means the route carries no permission guard of its own — the access tier below the table is then the whole of what stands in front of it.

Generated from Route. Hand edits to this table are overwritten on the next build — change the Go doc comment, or the generator.

Route Permission Who holds it Body
GET /api/v1/cronjobs cronjobs:read developer, operator, readonly, support returns CronJob
POST /api/v1/cronjobs cronjobs:create operator sends CronJob, returns CronJob
DELETE /api/v1/cronjobs/{name} cronjobs:delete operator —
GET /api/v1/cronjobs/{name} cronjobs:read developer, operator, readonly, support returns CronJob
PUT /api/v1/cronjobs/{name} cronjobs:update operator sends CronJob, returns CronJob
GET /api/v1/jobs jobs:read developer, operator, readonly, support returns Job
POST /api/v1/jobs jobs:create operator sends Job, returns Job
DELETE /api/v1/jobs/{name} jobs:delete operator —
GET /api/v1/jobs/{name} jobs:read developer, operator, readonly, support returns Job
PUT /api/v1/jobs/{name} jobs:update operator sends Job, returns Job
GET /api/v1/jobs/{name}/runs jobs:read developer, operator, readonly, support returns JobRun
POST /api/v1/jobs/{name}/runs jobs:run operator —
GET /api/v1/tasks admin an administrator only, through the wildcard grant —
POST /api/v1/tasks admin an administrator only, through the wildcard grant —
DELETE /api/v1/tasks/{id} admin an administrator only, through the wildcard grant —
GET /api/v1/tasks/{id} admin an administrator only, through the wildcard grant —
POST /api/v1/tasks/{id}/rollback admin an administrator only, through the wildcard grant —

Who can reach these at all

Section titled “Who can reach these at all”

authenticated — Behind authentication, cross-site-request-forgery validation and tenant extraction. Every call acts inside exactly one tenant.

Reachable only by an administrator

Section titled “Reachable only by an administrator”

No role holds the permissions below explicitly. They are satisfied by the administrator’s wildcard grant and by nothing else, so an operator or a developer cannot call these routes however their tenant is configured. That is a role-model question rather than a documentation one; it is recorded here because a reader planning around it needs to know before they try.

  • GET /api/v1/tasks — needs admin
  • POST /api/v1/tasks — needs admin
  • DELETE /api/v1/tasks/{id} — needs admin
  • GET /api/v1/tasks/{id} — needs admin
  • POST /api/v1/tasks/{id}/rollback — needs admin