Update Runbook
update_runbookUpdate a runbook's fields, including name, status, schedule, RTO, folder, template settings, and custom dashboard values, by specifying its runbook ID.
Instructions
Update a specific runbook's fields.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"runbook_id": "<runbook_id>"
},
"name": "update_runbook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rto | No | Recovery Time Objective in seconds (optional). | |
| name | No | The new name for the runbook (optional). | |
| status | No | The new RAG status for the runbook (Allowed: off, red, amber, green). | |
| timezone | No | IANA Timezone name (optional). | |
| folder_id | No | ID of the folder to move the runbook to (optional, relationship field). | |
| auto_start | No | Whether to auto-start the runbook once start_scheduled is reached. Auto-started runbooks run in live mode with comms on. | |
| runbook_id | Yes | The unique identifier for the runbook (required). | |
| description | No | The new description for the runbook (optional). | |
| is_template | No | Whether the runbook is a template (optional, true/false). | |
| rto_end_task | No | ID of the end task for RTO/RTA feature (optional, relationship field). | |
| end_scheduled | No | ISO 8601 timestamp for the runbook's scheduled end. Must be omitted if start_scheduled is not set. | |
| rto_start_task | No | ID of the start task for RTO/RTA feature (optional, relationship field). | |
| master_template | No | Whether this runbook can be used to create app-specific templates from the Workspace Data Sources view. Requires is_template=True; the API rejects setting this on a non-template runbook. Do NOT respond to that rejection by also setting is_template=True in the same or a follow-up call unless the user explicitly asked for the runbook to become a template ā silently converting a live runbook into a template is a significant, hard-to-reverse side effect. Surface the rejection and ask the user instead. | |
| start_scheduled | No | ISO 8601 timestamp, or the literal string "now", to schedule the runbook's start. The scheduler ignores times in the past. | |
| custom_field_values | No | Custom field values to update, including the runbook dashboard fields on the runbook homepage (e.g. Executive summary, Additional notes), the Post-Implementation Review (PIR) and the Incident Review (e.g. Incident Summary, RCA, Lessons Learned). Identify each field by custom_field_id, using the id returned by list_custom_fields with scope="runbook": {"custom_field_id": "123", "value": ...}. A field's internal ``name`` (e.g. "dashboard:incident_review:lessons_learned") can be used instead of the id, but its ``display_name`` ("Lessons Learned") cannot. For select_menu and radiobox fields, pass the option name; for checkboxes, pass a list of option names. Pass "" to clear a field. Values in the response are listed by ``name``, with custom_field_id set to null. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| included | No |