Squadcast Support

The Squadcast support Developer Hub

Welcome to the Squadcast support developer hub. You'll find comprehensive guides and documentation to help you start working with Squadcast support as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Squadcast Runbooks

Execute Squadcast Runbooks on your servers directly from an incident

You can execute Squadcast Runbooks as one of the Squadcast Actions and resolve your incidents quickly and bring down your MTTR significantly.

Setup Squadcast Runbooks

In order to execute Squadcast Runbooks as part of Squadcast actions, you need to perform the Squadcast Runbooks integration as described below.

Get your Squadcast Runbooks API key

Follow the below steps to get your Squadcast Runbooks API key.

Go to SidebarIntegrations and click on the Integrate button under Squadcast Runbooks.

Copy the Integration API key from the display box by clicking the copy button. This will activate the Runbooks tab in the sidebar, if you are not able to see the Runbooks tab, please reload your page.

Download and configure Squadcast Agent with the API key

  1. Download the Squadcast Agent for your OS platform
  2. Set it up as a service in the following format by supplying your API key in the system where you want to execute your Squadcast Runbooks.
squadcast-agent -key YOUR-API-KEY-HERE

You can configure as many agents in as many systems as you want using the same API key. Each agent will be identified using their unique hostname.

Now your Squadcast Runbooks Integration is good to go. You can setup Squadcast Runbooks and execute them as part of Squadcast Actions.

Create Runbooks

Follow the below steps to create Runbooks.

  1. Go to the Runbooks tab from the sidebar and click on Add New Runbook button.
  1. Enter a Name and Description for the runbook and click on the Create New button.
  1. In the next page, you can add code snippets which needs to be executed as well as textual description and steps. You can add a name for the Snippet, define the description and add code snippets.

Markdown supported

The Runbook Snippets description supports markdown and you can use it to describe the runbook clearly.

Runbooks support

Currently, Squadcast Runbooks supports the below languages...

  • Shell script
  • Lua script
  • Python3 script
  • NodeJS script
  • Ansible configuration

You can choose to use a single snippet or add as many as you want based on need and click on Save Runbook button.

Execute Squadcast Runbooks as Squadcast Actions

Go to the Incident for which you want to execute the Squadcast Runbook.

Click on the More Actions button and click on Squadcast Runbooks and select the Run action.

Then Select an Agent of the system on which you want to execute the Runbook, then select the Runbook which you want to execute and choose the snippets which you want to execute in order and click the Run button.

The Runbook will start running on your system and you can go to the Runbook execution page by following the link in the dialog box or by clicking the link on the Incident timeline.

Here you can watch the Squadcast Runbooks being executed and the logs being streamed live.

You can also watch the logs of old runs for that particular runbook.

All these Squadcast Runbooks executions are captured in the Incident Timeline as part of Actions and can be referenced anytime.

Start creating Squadcast Runbooks for all your routine tasks and make your life easier.

Squadcast Runbooks


Execute Squadcast Runbooks on your servers directly from an incident

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.