> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/runbooks.md).

# Runbooks

A runbook is the response procedure for a failing service: when to act, what to check, how to recover, whom to escalate to and how to confirm recovery. You link a runbook to a monitor so responders find it from the monitor and its status page.

Open it from **Workspaces** → **Service Health** → **Runbooks** in the sidebar.

{% hint style="info" %}
Requires the **Service Health** licence.
{% endhint %}

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FcwuFA46uqREOOT7SAfg7%2Fv2-sh-runbooks.png?alt=media&amp;token=74290a4e-c16f-4d3e-835b-f895a205b441" alt="Runbooks list"><figcaption><p>Runbooks</p></figcaption></figure>

## Runbooks List

The list has a search box, **Refresh**, **Columns** and **Export**.

| Column        | Description                                                                                                           |
| ------------- | --------------------------------------------------------------------------------------------------------------------- |
| **Runbook**   | Runbook name and the start of its procedure. Click the name to read it.                                               |
| **Procedure** | **Written in IZ Suite**, or **External procedure ↗** when the runbook links to a procedure your team keeps elsewhere. |
| **Updated**   | When the runbook last changed.                                                                                        |
| **Actions**   | **Read runbook** and delete.                                                                                          |

{% hint style="info" %}
A monitoring policy creates starter runbooks for the resource types it monitors. Edit them freely: the policy never overwrites or re-creates them.
{% endhint %}

## Create a Runbook

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FkMQ1nx36cRNtkESlXYVd%2Fv2-sh-runbook-create.png?alt=media&amp;token=0ee3c0e7-edea-4b6c-8cd5-f9a08cd6c56d" alt="Create response runbook form"><figcaption><p>Create response runbook</p></figcaption></figure>

1. Click **Create runbook**.
2. To reuse an existing procedure, search under **Start from a saved runbook** and click **Use saved procedure**. This creates an independent copy; the saved runbook is unchanged.
3. Fill in the fields below. Click **Use starter outline** to start from sections for when to use the procedure, the evidence to check, the response and how to verify recovery.
4. Click **Preview procedure** to see the formatted text, and **Edit procedure** to go back.
5. Click **Save runbook**.

| Field                       | Description                                                                                             |
| --------------------------- | ------------------------------------------------------------------------------------------------------- |
| **Runbook name**            | **Required.** Up to 100 characters.                                                                     |
| **External procedure link** | Optional `http` or `https` link to the procedure your team maintains.                                   |
| **Response procedure**      | The procedure in Markdown: when to act, checks to perform, recovery steps, escalation and verification. |

## Read a Runbook

Click **Read runbook** on a row. The drawer shows:

* **Edit runbook**, **Open external procedure** (when a link is set) and **Download procedure** (a Markdown file).
* **Response procedure**: the formatted procedure.
* **Monitors using this procedure**: each linked monitor version and whether it is enabled. Click one to open it in [Monitors](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/monitors.md).

## Link a Runbook to a Monitor

Edit the monitor, expand **More details · version, system, visibility and runbook**, and choose the runbook in **Response runbook**. See [Monitors](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/monitors.md#create-an-http-monitor).

{% hint style="warning" %}
A runbook that is still linked to monitors cannot be deleted, unless a monitoring policy created it. You need a role that can create monitors to create runbooks, a role that can edit monitors to edit them, and a role that can delete monitors to delete them.
{% endhint %}

## Next Steps

* [Monitors](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/monitors.md): link the runbook to the monitors it covers.
* [Maintenance Windows](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/maintenance-windows.md): plan the work a runbook describes.
* [Service Readiness](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/service-readiness.md): track how many services have a response procedure.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/workspaces/service-health/runbooks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
