Schedules
Recurring executions of a task in an environment, defined by a cron expression.
| Command | HTTP | Description |
|---|---|---|
schedules list | GET /v1/schedules | List schedules |
schedules create | POST /v1/schedules | Schedule a Task in an environment |
schedules get | GET /v1/schedules/{id} | Get schedule details |
schedules update | PATCH /v1/schedules/{id} | Update, pause or resume a schedule |
schedules delete | DELETE /v1/schedules/{id} | Cancel schedule (soft delete) |
Examples​
--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits the fields that come back — worth using on every list/get to save context. See Global flags for the full reference.
# List schedules
kobana kadu schedules list --fields "id"
# Schedule a Task in an environment
kobana kadu schedules create \
--json '{"task_id": "TASK_ID", "environment_id": "ENVIRONMENT_ID", "cron": "CRON"}'
# Get schedule details
kobana kadu schedules get --params '{"id": "SCHEDULE_ID"}'
# Update, pause or resume a schedule
kobana kadu schedules update --params '{"id": "SCHEDULE_ID"}'
# Cancel schedule (soft delete)
kobana kadu schedules delete \
--params '{"id": "SCHEDULE_ID"}' \
--dry-run
Next steps​
- Files
- Schema introspection — every parameter this resource accepts.