Schedules
Schedule your xRunBooks via our API
Last updated
Was this helpful?
Schedule your xRunBooks via our API
Last updated
Was this helpful?
List schedules
/v1alpha1/schedules
tid is the unique request id.
filter expression.
page_size specifies the maximum number of results to be returned.
page_token is used to request a specific page of the list results.
order_by is used to sort the fields by ascending or descending.
Creates and returns a Schedule object on Success and error on failure
/v1alpha1/schedules
Schedule contains basic details about a schedule.
Get details about a particular schedule
/v1alpha1/schedules/{scheduleId}
schedule_id is the id of the schedule.
tid is the unique request id.
Deletes a particular schedule
/v1alpha1/schedules/{scheduleId}
schedule_id is the id of the schedule.
tid is the unique request id.
Update certain fields of a schedule.
/v1alpha1/schedules/{scheduleId}
schedule_id is the id of schedule.
tid is the unique request id.
id is the id of the schedule.
environment_name is the name of the environment under which the schedule should be created.
input_schema is the workflow's input schema.
params are params for creating a calendar.
last_run captures the time it was last run.
last_updated captures the time it was last updated.
proxy_id is the id of the proxy under which the schedule should be created.
runbook_id is the id of the runbook under which the schedule should be created.
runbook_name is the name of the runbook under which the schedule should be created.