Links
Comment on page

Schedules

Schedule your xRunBooks via our API

List all Schedules

Example:
curl 'https://<your domain>/v1alpha1/schedules?pageSize=1&pageToken=1' \
-H "X-unSkript-API-Key:>token>"
get
/v1alpha1/schedules
List schedules

Create a Schedule

This schedules "unSkript Rules" to run at 5 AM (GMT) every day:
curl -X POST 'https://<api domain>/v1alpha1/schedules' \
-H "X-unSkript-API-Key:<api token>" \
-d '{"schedule":{"proxyId":"1499f27c-640sdfds6-4fbd-bd1b-c6f92800018f",
"runbookName":"unSkript rulez",
"runbookId":"14fac589-5849-403b-afcf-ed80as79099500",
"schedule":"* 5 * * *"}}'
post
/v1alpha1/schedules
Create a Schedule

Get a Specific Schedule's details

curl 'https://<domain>/v1alpha1/schedules/97b8208a-7b05-4212-b1c3-2e0f0abe8060' \
-H "X-unSkript-API-Key:<api key>"
get
/v1alpha1/schedules/{scheduleId}
Get schedule details

Delete a schedule

curl -X DELETE 'https://<domain>/v1alpha1/schedules/c67888f8-2df8-4248-9280-5c4b3589cf43' \
-H "X-unSkript-API-Key:<api token>"
delete
/v1alpha1/schedules/{scheduleId}
Delete a Schedule

Update a Schedule

patch
/v1alpha1/schedules/{scheduleId}
Update a Schedule