> ## Documentation Index
> Fetch the complete documentation index at: https://chatcli.edilsonfreitas.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar Runbooks

> Retorna a lista de runbooks de remediação configurados

<ParamField query="category" type="string">
  Filtrar por categoria: `oomkill`, `crashloop`, `latency`, `scaling`, `disk`, `network`, `custom`
</ParamField>

<ParamField query="severity" type="string">
  Filtrar por severidade alvo: `critical`, `high`, `medium`, `low`
</ParamField>

<ParamField query="automated" type="boolean">
  Filtrar por tipo de execução: `true` (automático), `false` (manual)
</ParamField>

<ParamField query="page" type="integer" default="1">
  Número da página
</ParamField>

<ParamField query="pageSize" type="integer" default="20">
  Itens por página (máximo 100)
</ParamField>

<ResponseExample>
  ```json Response 200 theme={"system"}
  {
    "apiVersion": "v1",
    "kind": "RunbookList",
    "metadata": {
      "totalCount": 12,
      "page": 1,
      "pageSize": 20
    },
    "items": [
      {
        "name": "runbook-oomkill-standard",
        "category": "oomkill",
        "description": "Remediação padrão 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": "Diagnóstico e correção 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"
      }
    ]
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /runbooks
openapi: 3.1.0
info:
  title: ChatCLI AIOps Platform API
  description: >-
    REST API for the ChatCLI AIOps Platform — incidents, SLOs, runbooks,
    approvals, postmortems, analytics, audit, federation and health.


    The playground below uses **editable server variables** so you can point
    requests at your own self-hosted instance. Adjust `host`, `port` and
    `basePath` to match your deployment, then click **Try it**.
  version: 1.0.0
  contact:
    name: ChatCLI
    url: https://github.com/diillson/chatcli
  license:
    name: Apache-2.0
    identifier: Apache-2.0
servers:
  - url: http://{host}:{port}/{basePath}
    description: >-
      Self-hosted ChatCLI AIOps Platform — adjust host, port and basePath to
      match your deployment.
    variables:
      host:
        default: localhost
        description: >-
          Hostname or IP of your ChatCLI operator. For Kubernetes, use the
          Service DNS (e.g. chatcli-api.chatcli-system.svc) or your Ingress
          host.
      port:
        default: '8090'
        description: >-
          Port the API listens on. Default is 8090; configurable via Helm value
          `apiPort` or env var CHATCLI_API_PORT.
      basePath:
        default: api/v1
        description: >-
          API base path. Always `api/v1` unless you have a custom proxy rewrite
          in front of the operator.
security:
  - ApiKeyAuth: []
tags:
  - name: Incidents
    description: >-
      Incident lifecycle: list, fetch, acknowledge, resolve, snooze, timeline
      and remediation views.
  - name: Runbooks
    description: Remediation runbooks (list, create, update, delete).
  - name: SLOs
    description: Service Level Objectives and error budgets.
  - name: Approvals
    description: Approval workflow for risky remediations.
  - name: Postmortems
    description: Auto-generated postmortems with review, feedback and close.
  - name: Remediations
    description: Remediation plans and agentic execution history.
  - name: AI Insights
    description: AI root-cause analysis and recommendations per incident.
  - name: Analytics
    description: 'Operational analytics: MTTD, MTTR, trends, capacity, compliance.'
  - name: Audit
    description: Immutable audit log and exports.
  - name: Federation
    description: 'Multi-cluster federation: clusters, status and cross-cluster correlations.'
  - name: Health
    description: Liveness and readiness probes.
paths:
  /runbooks:
    get:
      tags:
        - Runbooks
      summary: List Runbooks
      description: Returns the list of configured remediation runbooks.
      operationId: listRunbooks
      parameters:
        - name: category
          in: query
          required: false
          description: Filter by category.
          schema:
            type: string
            enum:
              - oomkill
              - crashloop
              - latency
              - scaling
              - disk
              - network
              - custom
        - name: severity
          in: query
          required: false
          description: Filter by target severity.
          schema:
            type: string
            enum:
              - critical
              - high
              - medium
              - low
        - name: automated
          in: query
          required: false
          description: 'Filter by execution type: `true` = automated, `false` = manual.'
          schema:
            type: boolean
        - name: page
          in: query
          required: false
          description: Page number.
          schema:
            type: integer
            default: 1
        - name: pageSize
          in: query
          required: false
          description: Items per page (max 100).
          schema:
            type: integer
            default: 20
            maximum: 100
      responses:
        '200':
          description: Paginated list of runbooks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunbookList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    RunbookList:
      type: object
      properties:
        apiVersion:
          type: string
          example: v1
        kind:
          type: string
          example: RunbookList
        metadata:
          $ref: '#/components/schemas/ListMetadata'
        items:
          type: array
          items:
            $ref: '#/components/schemas/RunbookListItem'
    ListMetadata:
      type: object
      properties:
        totalCount:
          type: integer
          example: 42
        page:
          type: integer
          example: 1
        pageSize:
          type: integer
          example: 20
    RunbookListItem:
      type: object
      properties:
        name:
          type: string
        category:
          type: string
        description:
          type: string
        version:
          type: string
        automated:
          type: boolean
        approvalRequired:
          type: boolean
        severity:
          type: array
          items:
            type: string
        stepsCount:
          type: integer
        avgExecutionTime:
          type: string
        successRate:
          type: number
        lastUsed:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - apiVersion
        - kind
        - error
      properties:
        apiVersion:
          type: string
          example: v1
        kind:
          type: string
          example: Error
        error:
          oneOf:
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: integer
                  example: 404
                message:
                  type: string
                  example: Resource not found
                details:
                  type: string
            - type: string
        code:
          type: integer
          description: Top-level code (only used by some endpoints).
          example: 400
  responses:
    Unauthorized:
      description: Missing or invalid API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded for this token's role
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Bearer token issued by the operator. Format: `Authorization: Bearer
        <token>`.

````