Skip to content
SHC Docs

Schedule API

  • 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.

MethodPathPermission
POST/api/method/shc.schedule.createstack:operate
POST/api/method/shc.schedule.disablestack:operate
POST/api/method/shc.schedule.enablestack:operate
GET/api/method/shc.schedule.infostack:read
GET/api/method/shc.schedule.liststack:read
POST/api/method/shc.schedule.liststack:read
POST/api/method/shc.schedule.removestack:operate
POST/api/method/shc.schedule.syncstack:operate
POST/api/method/shc.schedule.updatestack:operate
  • 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
  • summary: change an existing schedule’s cron in place (shc schedule edit). The row keeps its id, enabled state and last_run_at; next_run_at is 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