Update Runbook

{
  "description": "Standard remediation for OOMKill: raise the memory limit to 2Gi and restart",
  "trigger": {
    "signalType": "oom_kill",
    "severity": "high",
    "resourceKind": "Deployment"
  },
  "steps": [
    {
      "name": "raise-memory-limit",
      "action": "AdjustResources",
      "description": "Raise the container memory limit",
      "params": {
        "memory_limit": "2Gi"
      }
    },
    {
      "name": "restart",
      "action": "RestartDeployment",
      "description": "Restart pods to reclaim memory"
    }
  ]
}

{
  "apiVersion": "v1",
  "kind": "Runbook",
  "spec": {
    "name": "oomkill-standard",
    "namespace": "production",
    "description": "Standard remediation for OOMKill: raise the memory limit to 2Gi and restart",
    "trigger": {
      "signalType": "oom_kill",
      "severity": "high",
      "resourceKind": "Deployment"
    },
    "steps": [
      {
        "name": "raise-memory-limit",
        "action": "AdjustResources",
        "description": "Raise the container memory limit",
        "params": {
          "memory_limit": "2Gi"
        }
      },
      {
        "name": "restart",
        "action": "RestartDeployment",
        "description": "Restart pods to reclaim memory"
      }
    ],
    "maxAttempts": 3,
    "creationTimestamp": "2026-01-10T08:00:00Z"
  },
  "resourceMeta": {
    "name": "oomkill-standard",
    "namespace": "production",
    "uid": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "creationTimestamp": "2026-01-10T08:00:00Z"
  }
}

PUT

runbooks

{name}

{
  "description": "Standard remediation for OOMKill: raise the memory limit to 2Gi and restart",
  "trigger": {
    "signalType": "oom_kill",
    "severity": "high",
    "resourceKind": "Deployment"
  },
  "steps": [
    {
      "name": "raise-memory-limit",
      "action": "AdjustResources",
      "description": "Raise the container memory limit",
      "params": {
        "memory_limit": "2Gi"
      }
    },
    {
      "name": "restart",
      "action": "RestartDeployment",
      "description": "Restart pods to reclaim memory"
    }
  ]
}

{
  "apiVersion": "v1",
  "kind": "Runbook",
  "spec": {
    "name": "oomkill-standard",
    "namespace": "production",
    "description": "Standard remediation for OOMKill: raise the memory limit to 2Gi and restart",
    "trigger": {
      "signalType": "oom_kill",
      "severity": "high",
      "resourceKind": "Deployment"
    },
    "steps": [
      {
        "name": "raise-memory-limit",
        "action": "AdjustResources",
        "description": "Raise the container memory limit",
        "params": {
          "memory_limit": "2Gi"
        }
      },
      {
        "name": "restart",
        "action": "RestartDeployment",
        "description": "Restart pods to reclaim memory"
      }
    ],
    "maxAttempts": 3,
    "creationTimestamp": "2026-01-10T08:00:00Z"
  },
  "resourceMeta": {
    "name": "oomkill-standard",
    "namespace": "production",
    "uid": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "creationTimestamp": "2026-01-10T08:00:00Z"
  }
}

string

required

Runbook name (e.g., oomkill-standard)

string

default:"default"

Namespace of the runbook (other namespaces are not searched)

This is a replace, not a patch: description, trigger and steps are always overwritten with what you send (an omitted field becomes empty, and an empty trigger is rejected by the CRD). Only maxAttempts (when greater than 0) and labels (when present) are optional. name and namespace in the body are ignored.

string

Purpose of the runbook

object

required

When the runbook applies. All three fields are required by the CRD.

Show Trigger properties

string

required

Anomaly signal, e.g. oom_kill, crashloop_backoff, error_rate, latency, pod_restart, cpu_high, memory_high, disk_pressure, image_pull_error (full list in the Anomaly CRD enum)

string

required

critical, high, medium or low

string

required

Kind of the affected resource, e.g. Deployment, StatefulSet, DaemonSet, Job, CronJob

object[]

required

Ordered steps (replaces the whole list)

Show Step properties

string

required

Step name

string

required

Remediation action type, e.g. AdjustResources, RestartDeployment, ScaleDeployment, RollbackDeployment, ExecDiagnostic

string

Why the step is needed and what it does

object

String key/value parameters for the action (e.g. {"memory_limit": "1Gi"}, {"replicas": "5"})

integer

default:"unchanged"

New maximum number of remediation attempts; ignored when 0 or omitted

object

Replaces all labels when provided; existing labels are kept when omitted

{
  "description": "Standard remediation for OOMKill: raise the memory limit to 2Gi and restart",
  "trigger": {
    "signalType": "oom_kill",
    "severity": "high",
    "resourceKind": "Deployment"
  },
  "steps": [
    {
      "name": "raise-memory-limit",
      "action": "AdjustResources",
      "description": "Raise the container memory limit",
      "params": {
        "memory_limit": "2Gi"
      }
    },
    {
      "name": "restart",
      "action": "RestartDeployment",
      "description": "Restart pods to reclaim memory"
    }
  ]
}

{
  "apiVersion": "v1",
  "kind": "Runbook",
  "spec": {
    "name": "oomkill-standard",
    "namespace": "production",
    "description": "Standard remediation for OOMKill: raise the memory limit to 2Gi and restart",
    "trigger": {
      "signalType": "oom_kill",
      "severity": "high",
      "resourceKind": "Deployment"
    },
    "steps": [
      {
        "name": "raise-memory-limit",
        "action": "AdjustResources",
        "description": "Raise the container memory limit",
        "params": {
          "memory_limit": "2Gi"
        }
      },
      {
        "name": "restart",
        "action": "RestartDeployment",
        "description": "Restart pods to reclaim memory"
      }
    ],
    "maxAttempts": 3,
    "creationTimestamp": "2026-01-10T08:00:00Z"
  },
  "resourceMeta": {
    "name": "oomkill-standard",
    "namespace": "production",
    "uid": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "creationTimestamp": "2026-01-10T08:00:00Z"
  }
}

{
  "apiVersion": "v1",
  "kind": "Error",
  "error": "Not Found",
  "code": 404,
  "message": "runbook not found: runbooks.platform.chatcli.io \"oomkill-standard\" not found"
}

Authorizations

X-API-Key

string

header

required

API key sent in the X-API-Key header. Keys are read from the Secret chatcli-operator-secrets, key api-keys (fallback: ConfigMap chatcli-operator-config, key api-keys) in the operator namespace, as a YAML list of {key, role, name, description} (name is the identity recorded on approval decisions); the operator chart creates it only with apiKeys.create: true. Roles: viewer < operator < admin — any other role string is denied everywhere. Changes are picked up within about 30 seconds; deleting both the Secret and the ConfigMap revokes every key. With no keys configured every /api/ call returns 401, unless CHATCLI_OPERATOR_DEV_MODE=true, which grants admin without a key (development only).

Path Parameters

name

string

required

Runbook name.

Example:

"oom-standard"

Query Parameters

namespace

string

default:default

Namespace of the object. Defaults to default — pass it for objects in any other namespace.

Body

application/json

name

string

required

Required on create; ignored on update.

Example:

"oom-standard"

namespace

string

default:default

Create only; ignored on update.

description

string

trigger

object

Show child attributes

steps

object[]

Show child attributes

maxAttempts

integer

Defaults to 3 on create; on update only values > 0 are applied.

labels

object

Show child attributes

Response

Runbook updated

apiVersion

string

Example:

"v1"

kind

string

Example:

"Runbook"

spec

object

Show child attributes

resourceMeta

object

Show child attributes

Get started

Documentation

Authorizations

Path Parameters

Query Parameters

Body

Response