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

List schedules

GET/v1alpha1/schedules

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

schedulesschedule - Return back the list with Schedules objects

nextPageTokenstring

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.

pageCountinteger (int32)

page_count is the number of pages.

totalCountinteger (int32)

total_count is the total number of schedules.

Request

JavaScriptCurlPython

const response = await fetch('/v1alpha1/schedules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedules": [
    {
      "id": "text",
      "proxyId": "text",
      "proxyName": "text",
      "runbookId": "text",
      "runbookName": "text",
      "inputSchema": "text",
      "params": "text",
      "schedule": "text",
      "lastRun": "2024-11-21T07:31:32.596Z",
      "lastUpdated": "2024-11-21T07:31:32.596Z",
      "userEmail": "text"
    }
  ],
  "nextPageToken": "text"
}

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

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

POST/v1alpha1/schedules

Body

application/json

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

schedulev1alpha1Schedule (object)

Schedule contains basic details about a schedule.

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

schedulev1alpha1Schedule (object)

Schedule contains basic details about a schedule.

Request

JavaScriptCurlPython

const response = await fetch('/v1alpha1/schedules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "id": "text",
    "proxyId": "text",
    "proxyName": "text",
    "runbookId": "text",
    "runbookName": "text",
    "inputSchema": "text",
    "params": "text",
    "schedule": "text",
    "lastRun": "2024-11-21T07:31:32.596Z",
    "lastUpdated": "2024-11-21T07:31:32.596Z",
    "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 details about a particular schedule

GET/v1alpha1/schedules/{scheduleId}

Path parameters

scheduleId*string

schedule_id is the id of the schedule.

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

schedulev1alpha1Schedule (object)

Schedule contains basic details about a schedule.

Request

JavaScriptCurlPython

const response = await fetch('/v1alpha1/schedules/{scheduleId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "id": "text",
    "proxyId": "text",
    "proxyName": "text",
    "runbookId": "text",
    "runbookName": "text",
    "inputSchema": "text",
    "params": "text",
    "schedule": "text",
    "lastRun": "2024-11-21T07:31:32.596Z",
    "lastUpdated": "2024-11-21T07:31:32.596Z",
    "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

Deletes a particular schedule

DELETE/v1alpha1/schedules/{scheduleId}

Path parameters

scheduleId*string

schedule_id is the id of the schedule.

Query parameters

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

Request

JavaScriptCurlPython

const response = await fetch('/v1alpha1/schedules/{scheduleId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200default

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

Update a Schedule

Update a Schedule

Update certain fields of a schedule.

PATCH/v1alpha1/schedules/{scheduleId}

Path parameters

scheduleId*string

schedule_id is the id of schedule.

Query parameters

Body

application/json

schedule is the details of the schedule.

idstring

id is the id of the schedule.

proxyIdstring

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

proxyNamestring

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

runbookId*string

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

runbookName*string

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

inputSchemastring

input_schema is the workflow's input schema.

paramsstring

params are params for creating a calendar.

schedule*schedule is the schedule of xRunBooks

lastRunstring (date-time)

last_run captures the time it was last run.

lastUpdatedstring (date-time)

last_updated captures the time it was last updated.

userEmailThe user who created the schedule

Response

200default

A successful response.

Body

application/json

respHdrResponseHeader is the common header which every response (GRPC/HTTP) should have

schedulev1alpha1Schedule (object)

Schedule contains basic details about a schedule.

Request

JavaScriptCurlPython

const response = await fetch('/v1alpha1/schedules/{scheduleId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "runbookId": "text",
      "runbookName": "text",
      "schedule": "text"
    }),
});
const data = await response.json();

Response

200default

{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  },
  "schedule": {
    "id": "text",
    "proxyId": "text",
    "proxyName": "text",
    "runbookId": "text",
    "runbookName": "text",
    "inputSchema": "text",
    "params": "text",
    "schedule": "text",
    "lastRun": "2024-11-21T07:31:32.596Z",
    "lastUpdated": "2024-11-21T07:31:32.596Z",
    "userEmail": "text"
  }
}