Skip to main content
POST
Create Runbook
string
required
Unique runbook name (slug, e.g., runbook-disk-cleanup)
string
required
Category: oomkill, crashloop, latency, scaling, disk, network, custom
string
required
Description of the runbook’s objective
string[]
required
List of target severities: critical, high, medium, low
boolean
default:"false"
Whether the runbook can be executed automatically
boolean
default:"true"
Whether approval is required before execution
boolean
default:"true"
Whether to perform automatic rollback on failure
object[]
required
List of runbook steps
object
Conditions for automatic matching with incidents

Authorizations

Authorization
string
header
required

Bearer token issued by the operator. Format: Authorization: Bearer <token>.

Body

application/json
name
string
required
Example:

"runbook-disk-cleanup"

category
enum<string>
required
Available options:
oomkill,
crashloop,
latency,
scaling,
disk,
network,
custom
description
string
required
severity
enum<string>[]
required
Available options:
critical,
high,
medium,
low
steps
object[]
required
automated
boolean
default:false
approvalRequired
boolean
default:true
rollbackOnFailure
boolean
default:true
matchConditions
object

Response

Runbook created

apiVersion
string
Example:

"v1"

kind
string
Example:

"Runbook"

metadata
object
spec
object