Skip to content

Execute runbook

POST
/api/v1/incidents/{incident_id}/runbook

Triggers automated runbook execution.

Authorizations

Parameters

Path Parameters

incident_id
required
string

Query Parameters

tenant_id
required

Tenant identifier

string

Tenant identifier

Request Body

Request body for runbook execution.

object
manual_confirmation
boolean

Responses

200

Successful Response

Result of a runbook execution attempt.

Args: incident_id: The incident this runbook was executed for. runbook_type: The type of runbook executed. success: Whether the execution succeeded. message: Human-readable result message. requires_confirmation: Whether manual confirmation is needed. destructive: Whether this runbook performs destructive actions. executed_at: ISO timestamp of execution. steps_completed: Number of steps completed. outcome: Detailed outcome string from RunbookExecutionRecord. execution_record: Full execution record for audit.

object
destructive
boolean
executed_at
string
execution_record
Any of:
object
key
additional properties
any
incident_id
string
""
message
string
""
outcome
string
""
requires_confirmation
boolean
runbook_type
string
""
steps_completed
integer
success
boolean

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string