curl --request GET \
--url {scheme}://{host}:{port}/{basePath}/runbooks \
--header 'X-API-Key: <api-key>'import requests
url = "{scheme}://{host}:{port}/{basePath}/runbooks"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('{scheme}://{host}:{port}/{basePath}/runbooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "{scheme}://{host}:{port}/{basePath}/runbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{scheme}://{host}:{port}/{basePath}/runbooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("{scheme}://{host}:{port}/{basePath}/runbooks")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("{scheme}://{host}:{port}/{basePath}/runbooks")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "RunbookList",
"metadata": {
"totalCount": 2,
"page": 1,
"pageSize": 20
},
"items": [
{
"name": "oomkill-standard",
"namespace": "production",
"description": "Standard remediation for OOMKill: raise the memory limit and restart the Deployment",
"trigger": {
"signalType": "oom_kill",
"severity": "high",
"resourceKind": "Deployment"
},
"steps": [
{
"name": "raise-memory-limit",
"action": "AdjustResources",
"description": "Raise the container memory limit",
"params": {
"memory_limit": "1Gi"
}
},
{
"name": "restart",
"action": "RestartDeployment",
"description": "Restart pods to reclaim memory"
}
],
"maxAttempts": 3,
"creationTimestamp": "2026-01-10T08:00:00Z"
},
{
"name": "crashloop-rollback",
"namespace": "production",
"description": "Roll back a Deployment stuck in CrashLoopBackOff after a rollout",
"trigger": {
"signalType": "crashloop_backoff",
"severity": "critical",
"resourceKind": "Deployment"
},
"steps": [
{
"name": "rollback",
"action": "RollbackDeployment",
"description": "Return to the previous ReplicaSet"
}
],
"maxAttempts": 2,
"creationTimestamp": "2026-01-12T09:30:00Z"
}
]
}
Listar Runbooks
Retorna a lista de recursos Runbook
curl --request GET \
--url {scheme}://{host}:{port}/{basePath}/runbooks \
--header 'X-API-Key: <api-key>'import requests
url = "{scheme}://{host}:{port}/{basePath}/runbooks"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('{scheme}://{host}:{port}/{basePath}/runbooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "{scheme}://{host}:{port}/{basePath}/runbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{scheme}://{host}:{port}/{basePath}/runbooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("{scheme}://{host}:{port}/{basePath}/runbooks")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("{scheme}://{host}:{port}/{basePath}/runbooks")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "RunbookList",
"metadata": {
"totalCount": 2,
"page": 1,
"pageSize": 20
},
"items": [
{
"name": "oomkill-standard",
"namespace": "production",
"description": "Standard remediation for OOMKill: raise the memory limit and restart the Deployment",
"trigger": {
"signalType": "oom_kill",
"severity": "high",
"resourceKind": "Deployment"
},
"steps": [
{
"name": "raise-memory-limit",
"action": "AdjustResources",
"description": "Raise the container memory limit",
"params": {
"memory_limit": "1Gi"
}
},
{
"name": "restart",
"action": "RestartDeployment",
"description": "Restart pods to reclaim memory"
}
],
"maxAttempts": 3,
"creationTimestamp": "2026-01-10T08:00:00Z"
},
{
"name": "crashloop-rollback",
"namespace": "production",
"description": "Roll back a Deployment stuck in CrashLoopBackOff after a rollout",
"trigger": {
"signalType": "crashloop_backoff",
"severity": "critical",
"resourceKind": "Deployment"
},
"steps": [
{
"name": "rollback",
"action": "RollbackDeployment",
"description": "Return to the previous ReplicaSet"
}
],
"maxAttempts": 2,
"creationTimestamp": "2026-01-12T09:30:00Z"
}
]
}
Runbook. Um runbook é oferecido para um incidente quando o seu trigger (signalType, severity, resourceKind) corresponde ao incidente; os seus steps viram as ações do RemediationPlan. Nenhum outro filtro é suportado.
{
"apiVersion": "v1",
"kind": "RunbookList",
"metadata": {
"totalCount": 2,
"page": 1,
"pageSize": 20
},
"items": [
{
"name": "oomkill-standard",
"namespace": "production",
"description": "Standard remediation for OOMKill: raise the memory limit and restart the Deployment",
"trigger": {
"signalType": "oom_kill",
"severity": "high",
"resourceKind": "Deployment"
},
"steps": [
{
"name": "raise-memory-limit",
"action": "AdjustResources",
"description": "Raise the container memory limit",
"params": {
"memory_limit": "1Gi"
}
},
{
"name": "restart",
"action": "RestartDeployment",
"description": "Restart pods to reclaim memory"
}
],
"maxAttempts": 3,
"creationTimestamp": "2026-01-10T08:00:00Z"
},
{
"name": "crashloop-rollback",
"namespace": "production",
"description": "Roll back a Deployment stuck in CrashLoopBackOff after a rollout",
"trigger": {
"signalType": "crashloop_backoff",
"severity": "critical",
"resourceKind": "Deployment"
},
"steps": [
{
"name": "rollback",
"action": "RollbackDeployment",
"description": "Return to the previous ReplicaSet"
}
],
"maxAttempts": 2,
"creationTimestamp": "2026-01-12T09:30:00Z"
}
]
}
Autorizações
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).
Parâmetros de consulta
Kubernetes namespace. Empty means all namespaces.
Page number (1-based). Invalid values fall back to 1.
x >= 1Items per page. Values above 100 are capped at 100.
1 <= x <= 100