Skip to main content

Schedules

Recurring executions of a task in an environment, defined by a cron expression.

CommandHTTPDescription
schedules listGET /v1/schedulesList schedules
schedules createPOST /v1/schedulesSchedule a Task in an environment
schedules getGET /v1/schedules/{id}Get schedule details
schedules updatePATCH /v1/schedules/{id}Update, pause or resume a schedule
schedules deleteDELETE /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​