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

get

List schedules

Query parameters

reqHdr.tidanyOptional

tid is the unique request id.

filteranyOptional

filter expression.

pageSizeanyOptional

page_size specifies the maximum number of results to be returned.

pageTokenanyOptional

page_token is used to request a specific page of the list results.

orderByanyOptional

order_by is used to sort the fields by ascending or descending.

Responses

application/json

objectOptional

ListScheduleResponse is the response to ListScheduleRequest.

application/json

get

HTTPcURLJavaScriptPython

GET /v1alpha1/schedules HTTP/1.1
Host: 
Accept: */*

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedules": [
    {
      "id": "text",
      "proxyId": "text",
      "proxyName": "text",
      "runbookId": "text",
      "runbookName": "text",
      "inputSchema": "text",
      "params": "text",
      "schedule": "text",
      "lastRun": "2025-04-19T11:14:10.662Z",
      "lastUpdated": "2025-04-19T11:14:10.662Z",
      "userEmail": "text"
    }
  ],
  "nextPageToken": "text",
  "pageCount": 1,
  "totalCount": 1
}

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 * * *"}}'

Create a Schedule

post

Creates and returns a Schedule object on Success and error on failure

Body

CreateScheduleRequest is the request to create new schedual for particular xRunbook.

reqHdrobjectOptional

scheduleobjectOptional

scheduler - Payload about the scheduler.

Responses

application/json

objectOptional

CreateScheduleResponse is the response to the CreateScheduleRequest.

application/json

post

HTTPcURLJavaScriptPython

POST /v1alpha1/schedules HTTP/1.1
Host: 
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": "2025-04-19T11:14:10.662Z",
    "lastUpdated": "2025-04-19T11:14:10.662Z",
    "userEmail": "text"
  }
}

Get a Specific Schedule's details

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

Get schedule details

get

Get details about a particular schedule

Path parameters

scheduleIdanyRequired

schedule_id is the id of the schedule.

Query parameters

reqHdr.tidanyOptional

tid is the unique request id.

Responses

application/json

objectOptional

GetScheduleResponse is the response to the GetScheduleRequest.

application/json

get

HTTPcURLJavaScriptPython

GET /v1alpha1/schedules/{scheduleId} HTTP/1.1
Host: 
Accept: */*

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "id": "text",
    "proxyId": "text",
    "proxyName": "text",
    "runbookId": "text",
    "runbookName": "text",
    "inputSchema": "text",
    "params": "text",
    "schedule": "text",
    "lastRun": "2025-04-19T11:14:10.662Z",
    "lastUpdated": "2025-04-19T11:14:10.662Z",
    "userEmail": "text"
  }
}

Delete a schedule

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

Delete a Schedule

delete

Deletes a particular schedule

Path parameters

scheduleIdanyRequired

schedule_id is the id of the schedule.

Query parameters

reqHdr.tidanyOptional

tid is the unique request id.

Responses

application/json

objectOptional

DeleteScheduleResponse is the response to the DeleteScheduleRequest.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1alpha1/schedules/{scheduleId} HTTP/1.1
Host: 
Accept: */*

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  }
}

Update a Schedule

Update a Schedule

patch

Update certain fields of a schedule.

Path parameters

scheduleIdanyRequired

schedule_id is the id of schedule.

Query parameters

reqHdr.tidanyOptional

tid is the unique request id.

Body

Schedule contains basic details about a schedule.

idstringRead-onlyOptional

id is the id of the schedule.

proxyIdstringOptional

proxy_id is the id of the proxy under which the schedule should be created.

proxyNamestringRead-onlyOptional

environment_name is the name of the environment under which the schedule should be created.

runbookIdstringRequired

runbook_id is the id of the runbook under which the schedule should be created.

runbookNamestringRequired

runbook_name is the name of the runbook under which the schedule should be created.

inputSchemastringOptional

input_schema is the workflow's input schema.

paramsstringOptional

params are params for creating a calendar.

schedulestringRequired

lastRunstring · date-timeRead-onlyOptional

last_run captures the time it was last run.

lastUpdatedstring · date-timeRead-onlyOptional

last_updated captures the time it was last updated.

userEmailstringRead-onlyOptional

Responses

application/json

objectOptional

UpdateScheduleResponse is the response to the UpdateScheduleRequest.

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1alpha1/schedules/{scheduleId} HTTP/1.1
Host: 
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": "2025-04-19T11:14:10.662Z",
    "lastUpdated": "2025-04-19T11:14:10.662Z",
    "userEmail": "text"
  }
}