Schedule API
Routers
Section titled “Routers”router→ prefix/api/method(tags: schedule)
Hand-maintained notes against modules/schedule/router.go. Route inventory (generated): routes.md. Response models (generated): response-models/schedule.md.
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.schedule.create | stack:operate |
POST | /api/method/shc.schedule.disable | stack:operate |
POST | /api/method/shc.schedule.enable | stack:operate |
GET | /api/method/shc.schedule.info | stack:read |
GET | /api/method/shc.schedule.list | stack:read |
POST | /api/method/shc.schedule.list | stack:read |
POST | /api/method/shc.schedule.remove | stack:operate |
POST | /api/method/shc.schedule.sync | stack:operate |
POST | /api/method/shc.schedule.update | stack:operate |
POST /api/method/shc.schedule.create
Section titled “POST /api/method/shc.schedule.create”- source:
modules/schedule/router.go
POST /api/method/shc.schedule.disable
Section titled “POST /api/method/shc.schedule.disable”- source:
modules/schedule/router.go
POST /api/method/shc.schedule.enable
Section titled “POST /api/method/shc.schedule.enable”- source:
modules/schedule/router.go
GET /api/method/shc.schedule.info
Section titled “GET /api/method/shc.schedule.info”- source:
modules/schedule/router.go
GET /api/method/shc.schedule.list
Section titled “GET /api/method/shc.schedule.list”- source:
modules/schedule/router.go
POST /api/method/shc.schedule.list
Section titled “POST /api/method/shc.schedule.list”- source:
modules/schedule/router.go
POST /api/method/shc.schedule.remove
Section titled “POST /api/method/shc.schedule.remove”- source:
modules/schedule/router.go
POST /api/method/shc.schedule.sync
Section titled “POST /api/method/shc.schedule.sync”- summary: reconcile an app’s declared crons (
app.yaml) into the schedule rows for a deployment. - query params:
environment,stack_name,job_name - source:
modules/schedule/router.go
POST /api/method/shc.schedule.update
Section titled “POST /api/method/shc.schedule.update”- summary: change an existing schedule’s cron in place (
shc schedule edit). The row keeps its id, enabled state andlast_run_at;next_run_atis recomputed while it is enabled. An app-declared row warns that the stack’s next install or update syncs the app’s cron back. - body:
job_name,cron,stack_name(required),environment - source:
modules/schedule/router.go
shc@docs:~$