Free Sandbox Blog GitHub Slack Community

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>"

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

Get a Specific Schedule's details

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

Delete a schedule

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

Update a Schedule

PreviousRunBooks NextCommand Line Tool

Last updated 1 year ago

Was this helpful?

List schedules

get

/v1alpha1/schedules

Query parameters

reqHdr.tidstring

tid is the unique request id.

filterstring

filter expression.

pageSizeinteger int32

page_size specifies the maximum number of results to be returned.

pageTokenstring

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

orderBystring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha1/schedules'

200

default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "nextPageToken": "text",
  "pageCount": 1,
  "totalCount": 1,
  "schedules": [
    {
      "userEmail": "text",
      "schedule": "text",
      "id": "text",
      "proxyName": "text",
      "inputSchema": "text",
      "params": "text",
      "lastRun": "2025-02-18T19:27:08.452Z",
      "lastUpdated": "2025-02-18T19:27:08.452Z",
      "proxyId": "text",
      "runbookId": "text",
      "runbookName": "text"
    }
  ]
}

A successful response.

Create a Schedule

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

post

/v1alpha1/schedules

Body

reqHdrRequestHeader is the common header which every request (GRPC/HTTP) should have

scheduleobject

Schedule contains basic details about a schedule.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1alpha1/schedules' \
  --header 'Content-Type: application/json' \
  --data '{"reqHdr":{"tid":"text"},"schedule":{"schedule":"text","runbookId":"text","runbookName":"text"}}'

200

default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "userEmail": "text",
    "schedule": "text",
    "id": "text",
    "proxyName": "text",
    "inputSchema": "text",
    "params": "text",
    "lastRun": "2025-02-18T19:27:08.452Z",
    "lastUpdated": "2025-02-18T19:27:08.452Z",
    "proxyId": "text",
    "runbookId": "text",
    "runbookName": "text"
  }
}

A successful response.

Get schedule details

Get details about a particular schedule

get

/v1alpha1/schedules/{scheduleId}

Path parameters

scheduleIdstringrequired

schedule_id is the id of the schedule.

Query parameters

reqHdr.tidstring

tid is the unique request id.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1alpha1/schedules/{scheduleId}'

200

default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "userEmail": "text",
    "schedule": "text",
    "id": "text",
    "proxyName": "text",
    "inputSchema": "text",
    "params": "text",
    "lastRun": "2025-02-18T19:27:08.452Z",
    "lastUpdated": "2025-02-18T19:27:08.452Z",
    "proxyId": "text",
    "runbookId": "text",
    "runbookName": "text"
  }
}

A successful response.

Delete a Schedule

Deletes a particular schedule

delete

/v1alpha1/schedules/{scheduleId}

Path parameters

scheduleIdstringrequired

schedule_id is the id of the schedule.

Query parameters

reqHdr.tidstring

tid is the unique request id.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1alpha1/schedules/{scheduleId}'

200

default

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

A successful response.

Update a Schedule

Update certain fields of a schedule.

patch

/v1alpha1/schedules/{scheduleId}

Path parameters

scheduleIdstringrequired

schedule_id is the id of schedule.

Query parameters

reqHdr.tidstring

tid is the unique request id.

Body

userEmailThe user who created the schedule

scheduleschedule is the schedule of xRunBooksrequired

idstring

id is the id of the schedule.

proxyNamestring

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

inputSchemastring

input_schema is the workflow's input schema.

paramsstring

params are params for creating a calendar.

lastRunstring date-time

last_run captures the time it was last run.

lastUpdatedstring date-time

last_updated captures the time it was last updated.

proxyIdstring

proxy_id is the id of the proxy 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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v1alpha1/schedules/{scheduleId}' \
  --header 'Content-Type: application/json' \
  --data '{"schedule":"text","runbookId":"text","runbookName":"text"}'

200

default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "userEmail": "text",
    "schedule": "text",
    "id": "text",
    "proxyName": "text",
    "inputSchema": "text",
    "params": "text",
    "lastRun": "2025-02-18T19:27:08.452Z",
    "lastUpdated": "2025-02-18T19:27:08.452Z",
    "proxyId": "text",
    "runbookId": "text",
    "runbookName": "text"
  }
}

A successful response.