Schedules API
GET /api/v1/schedules
Section titled “GET /api/v1/schedules”List Schedules
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful Response | any |
POST /api/v1/schedules
Section titled “POST /api/v1/schedules”Create Schedule
Request body (required), application/json, ScheduleIn
| Field | Type | Required | Description |
|---|---|---|---|
cron | string | yes | |
enabled | boolean | no | |
job_kind | string | yes | |
name | string | yes | |
params | object | null | no | |
timezone | string | no |
Responses
| Status | Description | Schema |
|---|---|---|
| 201 | Successful Response | any |
| 422 | Validation Error | HTTPValidationError |
DELETE /api/v1/schedules/{schedule_id}
Section titled “DELETE /api/v1/schedules/{schedule_id}”Delete Schedule
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
schedule_id | path | integer | yes |
Responses
| Status | Description | Schema |
|---|---|---|
| 204 | Successful Response | |
| 422 | Validation Error | HTTPValidationError |
PATCH /api/v1/schedules/{schedule_id}
Section titled “PATCH /api/v1/schedules/{schedule_id}”Patch Schedule
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
schedule_id | path | integer | yes |
Request body (required), application/json, SchedulePatch
| Field | Type | Required | Description |
|---|---|---|---|
cron | string | null | no | |
enabled | boolean | null | no | |
job_kind | string | null | no | |
name | string | null | no | |
params | object | null | no | |
timezone | string | null | no |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful Response | any |
| 422 | Validation Error | HTTPValidationError |
POST /api/v1/schedules/{schedule_id}/run
Section titled “POST /api/v1/schedules/{schedule_id}/run”Run Schedule Now
An extra run, not a reschedule: next_run_at deliberately does not move.
Unlike a tick-fired run this one carries requested_by; a human asked for
it, and the audit trail should say so.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
schedule_id | path | integer | yes |
Responses
| Status | Description | Schema |
|---|---|---|
| 202 | Successful Response | any |
| 422 | Validation Error | HTTPValidationError |