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>"List 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.
A successful response.
ListScheduleResponse is the response to ListScheduleRequest.
next_page_token represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request.
page_count is the number of pages.
total_count is the total number of schedules.
An unexpected error response.
GET /v1alpha1/schedules HTTP/1.1
Accept: */*
{
"respHdr": {
"tid": "text",
"requestTid": "text"
},
"schedules": [
{
"id": "text",
"proxyId": "text",
"proxyName": "text",
"runbookId": "text",
"runbookName": "text",
"inputSchema": "text",
"params": "text",
"schedule": "text",
"lastRun": "2026-01-01T00:00:00.000Z",
"lastUpdated": "2026-01-01T00:00:00.000Z",
"userEmail": "text"
}
],
"nextPageToken": "text",
"pageCount": 1,
"totalCount": 1
}Create a Schedule
This schedules "unSkript Rules" to run at 5 AM (GMT) every day:
Creates and returns a Schedule object on Success and error on failure
CreateScheduleRequest is the request to create new schedual for particular xRunbook.
A successful response.
CreateScheduleResponse is the response to the CreateScheduleRequest.
An unexpected error response.
POST /v1alpha1/schedules HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 150
{
"reqHdr": {
"tid": "text"
},
"schedule": {
"proxyId": "text",
"runbookId": "text",
"runbookName": "text",
"inputSchema": "text",
"params": "text",
"schedule": "text"
}
}{
"respHdr": {
"tid": "text",
"requestTid": "text"
},
"schedule": {
"id": "text",
"proxyId": "text",
"proxyName": "text",
"runbookId": "text",
"runbookName": "text",
"inputSchema": "text",
"params": "text",
"schedule": "text",
"lastRun": "2026-01-01T00:00:00.000Z",
"lastUpdated": "2026-01-01T00:00:00.000Z",
"userEmail": "text"
}
}Get a Specific Schedule's details
Get details about a particular schedule
schedule_id is the id of the schedule.
tid is the unique request id.
A successful response.
GetScheduleResponse is the response to the GetScheduleRequest.
An unexpected error response.
GET /v1alpha1/schedules/{scheduleId} HTTP/1.1
Accept: */*
{
"respHdr": {
"tid": "text",
"requestTid": "text"
},
"schedule": {
"id": "text",
"proxyId": "text",
"proxyName": "text",
"runbookId": "text",
"runbookName": "text",
"inputSchema": "text",
"params": "text",
"schedule": "text",
"lastRun": "2026-01-01T00:00:00.000Z",
"lastUpdated": "2026-01-01T00:00:00.000Z",
"userEmail": "text"
}
}Delete a schedule
Deletes a particular schedule
schedule_id is the id of the schedule.
tid is the unique request id.
A successful response.
DeleteScheduleResponse is the response to the DeleteScheduleRequest.
An unexpected error response.
DELETE /v1alpha1/schedules/{scheduleId} HTTP/1.1
Accept: */*
{
"respHdr": {
"tid": "text",
"requestTid": "text"
}
}Update a Schedule
Update certain fields of a schedule.
schedule_id is the id of schedule.
tid is the unique request id.
Schedule contains basic details about a schedule.
id is the id of the schedule.
proxy_id is the id of the proxy under which the schedule should be created.
environment_name is the name of the environment 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.
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.
A successful response.
UpdateScheduleResponse is the response to the UpdateScheduleRequest.
An unexpected error response.
PATCH /v1alpha1/schedules/{scheduleId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 113
{
"proxyId": "text",
"runbookId": "text",
"runbookName": "text",
"inputSchema": "text",
"params": "text",
"schedule": "text"
}{
"respHdr": {
"tid": "text",
"requestTid": "text"
},
"schedule": {
"id": "text",
"proxyId": "text",
"proxyName": "text",
"runbookId": "text",
"runbookName": "text",
"inputSchema": "text",
"params": "text",
"schedule": "text",
"lastRun": "2026-01-01T00:00:00.000Z",
"lastUpdated": "2026-01-01T00:00:00.000Z",
"userEmail": "text"
}
}Last updated
Was this helpful?