Update a runbook
PUT /runbooks/{id}
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”DocumentId
Request Body required
Section titled “Request Body required ”object
object
Alert filter condition, e.g. {metric: ‘cpu_percent’, operator: ’>’, threshold: 90}. Relevant only when trigger_type=alert.
Ordered array of actions: [{type: string, params: {}}]. Supported types: restart_service, clear_disk_space, kill_process, run_approved_script.
Minimum minutes between executions of this runbook for a given organisation.
Alertmanager alertname label that triggers this runbook (e.g. HighErrorRate). Leave blank to disable alert-based triggering.
When true, receiving an Alertmanager alert matching alert_name will automatically log this runbook as triggered.
Version number — incremented by createVersion action.
DocumentId of the runbook this version was forked from (null for the root version).
Draft flag — set to true when created via createVersion until promoted.
Human-readable notes describing what changed in this version.
Responses
Section titled “ Responses ”Updated
object
object
Alert filter condition, e.g. {metric: ‘cpu_percent’, operator: ’>’, threshold: 90}. Relevant only when trigger_type=alert.
Ordered array of actions: [{type: string, params: {}}]. Supported types: restart_service, clear_disk_space, kill_process, run_approved_script.
Minimum minutes between executions of this runbook for a given organisation.
Alertmanager alertname label that triggers this runbook (e.g. HighErrorRate). Leave blank to disable alert-based triggering.
When true, receiving an Alertmanager alert matching alert_name will automatically log this runbook as triggered.
Version number — incremented by createVersion action.
DocumentId of the runbook this version was forked from (null for the root version).
Draft flag — set to true when created via createVersion until promoted.
Human-readable notes describing what changed in this version.
Validation error
Missing or invalid authentication
Not authorized (tenant scope or capability)
Not found