unSkript Documentation
Free SandboxBlogGitHubSlack Community
  • What is unSkript?
  • Guides
    • Contribute to Open Source
    • Getting started
      • Sign Up/Install
      • Authentication
        • Okta configuration
          • Okta Groups Sync
      • Create a Proxy
      • Add Credentials to Connect your Resources
      • Key Terms
  • RunBooks
    • Prebuilt xRunBooks
      • xRunBooks for CloudOps
      • xRunBooks for Cost Optimization
      • xRunBooks for DevOps
      • xRunBooks for IAM
      • xRunBooks for SecOps
      • xRunBooks for SRE
      • xRunBooks for Troubleshooting
    • Creating RunBooks
      • Importing unSkript xRunBooks
      • Create a xRunBook
      • Add an Action
      • Connecting Actions
      • Create a RunBook Input Parameter
      • Create a Credential
      • Writing Notes
      • Running XRunBooks
        • Running RunBooks with Approvals
      • Schedules
      • xRunBook Executions
      • Alarms
        • Create an Alarm Webhook
          • Webhooks for onprem installations
        • Create a Grafana Alert
        • Attaching runbooks to alarms
      • Folders
      • RunBook Outputs
  • Actions
    • What is an Action?
    • Create Custom Actions
    • Create Actions with AI
    • Actions
      • Action Configuration
        • Configure Action Inputs
        • Add Action Inputs
        • Action Output
        • Action Iterator
          • Using Iterators
        • Action Poll
        • Action Start Condition
      • Anatomy of an Action
    • Prebuilt Actions
  • Healthchecks
    • What is a HealthCheck?
    • Create a HealthCheck
      • Create a HealthCheck Folder
      • Adding Checks
    • HealthCheck Parameters
    • Running HealthChecks
    • HealthCheck Remediation
  • Workflows
    • What is a Workflow?
  • Connnecting
    • Connectors
      • Airflow
        • Airflow Actions
      • AWS
        • AWS Actions
          • AWS Cloudwatch Actions
          • AWS EC2 Actions
          • AWS ECS Actions
          • AWS EKS Actions
          • AWS ELB Actions
          • AWS IAM Actions
          • AWS Postgres Actions
          • AWS RDS Actions
          • AWS RedShift Actions
          • AWS S3 Actions
          • AWS VPC Actions
      • Azure
        • Azure Actions
      • ChatGPT
        • ChatGPT Actions
      • Datadog
        • Configuring webhook in Datadog
        • Datadog Actions
          • Datadog Alert Actions
          • Datadog Metrics Actions
          • Datadog Monitor Actions
      • Elasticsearch
        • Elasticsearch Actions
      • GCP
        • GCP Actions
          • GCP Bucket Actions
          • GCP GKE Actions
          • GCP IAM Actions
          • GCP VM Actions
      • Github
        • Github Actions
      • Grafana
        • Grafana Actions
      • Hadoop
        • Hadoop Actions
      • Jenkins
        • Jenkins Actions
      • Jira
        • Jira Actions
      • Kafka
        • Kafka Actions
      • Kubernetes
        • K8s Actions
      • MongoDB
        • MongoDB Actions
      • MS SQL
        • MSSQL Actions
      • MySQL
        • MySQL Actions
      • Netbox
        • Netbox Actions
      • Nomad
        • Nomad Actions
      • OpenSearch
        • opensearch Actions
      • Pingdom
        • Pingdom Actions
      • Postgres
        • Postgres Actions
      • Prometheus
        • Prometheus Actions
      • Redis
        • Redis Actions
      • REST
        • REST Actions
      • SalesForce
        • SalesForce Actions
      • Slack
        • Slack Actions
      • Snowflake
        • Snowflake Actions
      • Splunk
        • Splunk Actions
      • SSH
        • SSH Actions
      • Stripe
        • Stripe Actions
      • Terraform
        • Terraform Actions
      • Zabbix
    • Proxies
      • Environment
        • RunBooks Across Environments: ServiceIDs
      • unSkript Proxy
      • AWS Proxy
      • GCP Proxy
    • Secret store
      • Vault
  • Tooling
    • Role Based Access Control
      • RBAC Roles
    • API reference
      • Authentication
      • Endpoints
        • Executions
        • RunBooks
        • Schedules
    • Command Line Tool
    • Notifications
  • Fundamentals
    • Jupyter Notebook 101
  • Use Cases
    • DevOps
    • SRE
  • Open source
    • Runbooks.sh
    • Contribute to Open Source
  • Lists
    • AWS Service Quota list
Powered by GitBook
On this page

Was this helpful?

  1. Tooling
  2. API reference
  3. Endpoints

Schedules

Schedule your xRunBooks via our API

PreviousRunBooksNextCommand Line Tool

Last updated 1 year ago

Was this helpful?

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

List schedules

get

List schedules

Query parameters
reqHdr.tidstringOptional

tid is the unique request id.

filterstringOptional

filter expression.

pageSizeinteger · int32Optional

page_size specifies the maximum number of results to be returned.

pageTokenstringOptional

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

orderBystringOptional

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

Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get
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-05-09T11:22:34.662Z",
      "lastUpdated": "2025-05-09T11:22:34.662Z",
      "userEmail": "text"
    }
  ],
  "nextPageToken": "text",
  "pageCount": 1,
  "totalCount": 1
}

Get schedule details

get

Get details about a particular schedule

Path parameters
scheduleIdstringRequired

schedule_id is the id of the schedule.

Query parameters
reqHdr.tidstringOptional

tid is the unique request id.

Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
get
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-05-09T11:22:34.662Z",
    "lastUpdated": "2025-05-09T11:22:34.662Z",
    "userEmail": "text"
  }
}

Delete a Schedule

delete

Deletes a particular schedule

Path parameters
scheduleIdstringRequired

schedule_id is the id of the schedule.

Query parameters
reqHdr.tidstringOptional

tid is the unique request id.

Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
delete
DELETE /v1alpha1/schedules/{scheduleId} HTTP/1.1
Host: 
Accept: */*
{
  "respHdr": {
    "tid": "text",
    "requestTid": "text"
  }
}
  • List all Schedules
  • GETList schedules
  • Create a Schedule
  • POSTCreate a Schedule
  • Get a Specific Schedule's details
  • GETGet schedule details
  • Delete a schedule
  • DELETEDelete a Schedule
  • Update a Schedule
  • PATCHUpdate a Schedule

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.

Responses
200
A successful response.
application/json
default
An unexpected error response.
application/json
post
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-05-09T11:22:34.662Z",
    "lastUpdated": "2025-05-09T11:22:34.662Z",
    "userEmail": "text"
  }
}

Update a Schedule

patch

Update certain fields of a schedule.

Path parameters
scheduleIdstringRequired

schedule_id is the id of schedule.

Query parameters
reqHdr.tidstringOptional

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
200
A successful response.
application/json
default
An unexpected error response.
application/json
patch
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-05-09T11:22:34.662Z",
    "lastUpdated": "2025-05-09T11:22:34.662Z",
    "userEmail": "text"
  }
}