List Runbooks
curl --request GET \
--url http://{host}:{port}/{basePath}/runbooks \
--header 'Authorization: <api-key>'import requests
url = "http://{host}:{port}/{basePath}/runbooks"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://{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 => "http://{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 => [
"Authorization: <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 := "http://{host}:{port}/{basePath}/runbooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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("http://{host}:{port}/{basePath}/runbooks")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{basePath}/runbooks")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "RunbookList",
"metadata": {
"totalCount": 12,
"page": 1,
"pageSize": 20
},
"items": [
{
"name": "runbook-oomkill-standard",
"category": "oomkill",
"description": "Remediacao padrao para eventos OOMKill — ajusta memory limits automaticamente",
"version": "1.3.0",
"automated": true,
"approvalRequired": true,
"severity": ["high", "critical"],
"stepsCount": 4,
"avgExecutionTime": "3m",
"successRate": 94.2,
"lastUsed": "2026-03-19T15:21:00Z",
"createdAt": "2026-01-10T08:00:00Z"
},
{
"name": "runbook-crashloop-restart",
"category": "crashloop",
"description": "Diagnostico e correcao de CrashLoopBackOff — coleta logs e reinicia com backoff",
"version": "2.0.1",
"automated": true,
"approvalRequired": false,
"severity": ["medium", "high"],
"stepsCount": 6,
"avgExecutionTime": "5m",
"successRate": 87.5,
"lastUsed": "2026-03-18T22:10:00Z",
"createdAt": "2026-01-10T08:00:00Z"
}
]
}
Runbooks
List Runbooks
Returns the list of configured remediation runbooks
GET
/
runbooks
List Runbooks
curl --request GET \
--url http://{host}:{port}/{basePath}/runbooks \
--header 'Authorization: <api-key>'import requests
url = "http://{host}:{port}/{basePath}/runbooks"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://{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 => "http://{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 => [
"Authorization: <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 := "http://{host}:{port}/{basePath}/runbooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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("http://{host}:{port}/{basePath}/runbooks")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{basePath}/runbooks")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"apiVersion": "v1",
"kind": "RunbookList",
"metadata": {
"totalCount": 12,
"page": 1,
"pageSize": 20
},
"items": [
{
"name": "runbook-oomkill-standard",
"category": "oomkill",
"description": "Remediacao padrao para eventos OOMKill — ajusta memory limits automaticamente",
"version": "1.3.0",
"automated": true,
"approvalRequired": true,
"severity": ["high", "critical"],
"stepsCount": 4,
"avgExecutionTime": "3m",
"successRate": 94.2,
"lastUsed": "2026-03-19T15:21:00Z",
"createdAt": "2026-01-10T08:00:00Z"
},
{
"name": "runbook-crashloop-restart",
"category": "crashloop",
"description": "Diagnostico e correcao de CrashLoopBackOff — coleta logs e reinicia com backoff",
"version": "2.0.1",
"automated": true,
"approvalRequired": false,
"severity": ["medium", "high"],
"stepsCount": 6,
"avgExecutionTime": "5m",
"successRate": 87.5,
"lastUsed": "2026-03-18T22:10:00Z",
"createdAt": "2026-01-10T08:00:00Z"
}
]
}
string
Filter by category:
oomkill, crashloop, latency, scaling, disk, network, customstring
Filter by target severity:
critical, high, medium, lowboolean
Filter by execution type:
true (automated), false (manual)integer
default:"1"
Page number
integer
default:"20"
Items per page (maximum 100)
{
"apiVersion": "v1",
"kind": "RunbookList",
"metadata": {
"totalCount": 12,
"page": 1,
"pageSize": 20
},
"items": [
{
"name": "runbook-oomkill-standard",
"category": "oomkill",
"description": "Remediacao padrao para eventos OOMKill — ajusta memory limits automaticamente",
"version": "1.3.0",
"automated": true,
"approvalRequired": true,
"severity": ["high", "critical"],
"stepsCount": 4,
"avgExecutionTime": "3m",
"successRate": 94.2,
"lastUsed": "2026-03-19T15:21:00Z",
"createdAt": "2026-01-10T08:00:00Z"
},
{
"name": "runbook-crashloop-restart",
"category": "crashloop",
"description": "Diagnostico e correcao de CrashLoopBackOff — coleta logs e reinicia com backoff",
"version": "2.0.1",
"automated": true,
"approvalRequired": false,
"severity": ["medium", "high"],
"stepsCount": 6,
"avgExecutionTime": "5m",
"successRate": 87.5,
"lastUsed": "2026-03-18T22:10:00Z",
"createdAt": "2026-01-10T08:00:00Z"
}
]
}
Authorizations
Bearer token issued by the operator. Format: Authorization: Bearer <token>.
Query Parameters
Filter by category.
Available options:
oomkill, crashloop, latency, scaling, disk, network, custom Filter by target severity.
Available options:
critical, high, medium, low Filter by execution type: true = automated, false = manual.
Page number.
Items per page (max 100).
Required range:
x <= 100⌘I