> ## 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.

# Correlações da Federação

> Retorna correlações de incidentes entre clusters — incidentes com a mesma causa raiz detectados em múltiplos clusters

## Campos de Correlação

| Campo                | Descrição                                                                    |
| -------------------- | ---------------------------------------------------------------------------- |
| `correlationId`      | ID único agrupando incidentes relacionados entre clusters                    |
| `issue`              | Nome do incidente principal                                                  |
| `severity`           | Severidade do incidente                                                      |
| `signalType`         | O sinal que disparou a correlação                                            |
| `correlatedClusters` | Lista separada por virgulas dos nomes dos clusters afetados                  |
| `elevated`           | Se a severidade foi automaticamente elevada devido ao impacto entre clusters |
| `cascade`            | Se uma falha em cascata foi detectada (propagacao de staging para produção)  |

<ResponseExample>
  ```json Response 200 theme={"system"}
  {
    "apiVersion": "v1",
    "kind": "FederationCorrelations",
    "metadata": {
      "totalCount": 2,
      "page": 1,
      "pageSize": 2
    },
    "items": [
      {
        "correlationId": "cross-abc123",
        "issue": "api-gateway-oom-kill-1774211224",
        "namespace": "production",
        "severity": "critical",
        "signalType": "oom_kill",
        "correlatedClusters": "prod-us-east-1,prod-eu-west-1,prod-ap-southeast-1",
        "elevated": true,
        "cascade": false
      },
      {
        "correlationId": "cross-def456",
        "issue": "payment-service-deploy-failing-1774211300",
        "namespace": "production",
        "severity": "high",
        "signalType": "deploy_failing",
        "correlatedClusters": "staging-us-east-1,prod-us-east-1",
        "elevated": true,
        "cascade": true
      }
    ]
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /federation/correlations
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:
  /federation/correlations:
    get:
      tags:
        - Federation
      summary: Federation Correlations
      description: >-
        Returns cross-cluster incident correlations — incidents with the same
        root cause detected on multiple clusters.
      operationId: federationCorrelations
      responses:
        '200':
          description: Cross-cluster correlations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FederationCorrelations'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    FederationCorrelations:
      type: object
      properties:
        apiVersion:
          type: string
          example: v1
        kind:
          type: string
          example: FederationCorrelations
        metadata:
          $ref: '#/components/schemas/ListMetadata'
        items:
          type: array
          items:
            $ref: '#/components/schemas/FederationCorrelationItem'
    ListMetadata:
      type: object
      properties:
        totalCount:
          type: integer
          example: 42
        page:
          type: integer
          example: 1
        pageSize:
          type: integer
          example: 20
    FederationCorrelationItem:
      type: object
      properties:
        correlationId:
          type: string
        issue:
          type: string
        namespace:
          type: string
        severity:
          type: string
        signalType:
          type: string
        correlatedClusters:
          type: string
          description: Comma-separated cluster names.
        elevated:
          type: boolean
        cascade:
          type: boolean
    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>`.

````