> ## 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.
# Obter Incidente
> Retorna os detalhes completos de um incidente específico
Nome único do incidente (ex: `INC-20260319-001`)
```json Response 200 theme={"system"}
{
"apiVersion": "v1",
"kind": "Incident",
"metadata": {
"name": "INC-20260319-001",
"namespace": "production",
"createdAt": "2026-03-19T15:20:00Z",
"labels": {
"app": "payment-service",
"team": "platform",
"severity": "high"
}
},
"spec": {
"resource": "Deployment/payment-service",
"severity": "high",
"description": "OOMKill detected — container reiniciado 5 vezes nos ultimos 10 minutos",
"detectionSource": "k8s-watcher",
"correlationId": "corr-abc123",
"runbook": "runbook-oomkill-standard",
"escalationPolicy": "pagerduty-critical"
},
"status": {
"state": "Analyzing",
"riskScore": 65,
"analysisResult": {
"rootCause": "Memory limit de 512Mi insuficiente para carga atual",
"recommendation": "Aumentar memory limit para 1Gi",
"confidence": 0.87,
"relatedEvents": [
"Pod payment-service-7d4b8c9f6-x2k4m OOMKilled",
"HPA unable to scale — max replicas reached"
]
},
"acknowledged": false,
"assignedTo": "sre-team",
"detectedAt": "2026-03-19T15:20:00Z",
"lastUpdated": "2026-03-19T15:25:00Z",
"timelineCount": 8
}
}
```
```json Response 404 theme={"system"}
{
"apiVersion": "v1",
"kind": "Error",
"error": {
"code": 404,
"message": "Incidente não encontrado",
"details": "O incidente 'INC-20260319-999' não existe"
}
}
```
## OpenAPI
````yaml GET /incidents/{name}
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:
/incidents/{name}:
get:
tags:
- Incidents
summary: Get Incident
description: Returns full details of a specific incident.
operationId: getIncident
parameters:
- name: name
in: path
required: true
description: Unique incident name (e.g. `INC-20260319-001`).
schema:
type: string
example: INC-20260319-001
responses:
'200':
description: Incident details
content:
application/json:
schema:
$ref: '#/components/schemas/Incident'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
components:
schemas:
Incident:
type: object
properties:
apiVersion:
type: string
example: v1
kind:
type: string
example: Incident
metadata:
type: object
properties:
name:
type: string
namespace:
type: string
createdAt:
type: string
format: date-time
annotations:
type: object
additionalProperties:
type: string
labels:
type: object
additionalProperties:
type: string
spec:
type: object
properties:
resource:
type: string
resourceRef:
type: object
properties:
kind:
type: string
name:
type: string
namespace:
type: string
severity:
type: string
description:
type: string
detectionSource:
type: string
correlationId:
type: string
runbook:
type: string
escalationPolicy:
type: string
signalType:
type: string
status:
type: object
properties:
state:
type: string
enum:
- Detected
- Analyzing
- Remediating
- Contained
- Resolved
- Escalated
- Failed
description: >-
Lifecycle state. Contained (GAP-03 fix) indicates the workload
was silenced via a containment action and human intervention is
required to restore service.
riskScore:
type: integer
analysisResult:
type: object
properties:
rootCause:
type: string
recommendation:
type: string
confidence:
type: number
relatedEvents:
type: array
items:
type: string
acknowledged:
type: boolean
acknowledgedBy:
type: string
acknowledgedAt:
type: string
format: date-time
message:
type: string
snoozed:
type: boolean
snoozedBy:
type: string
snoozedAt:
type: string
format: date-time
snoozeUntil:
type: string
format: date-time
snoozeReason:
type: string
assignedTo:
type: string
detectedAt:
type: string
format: date-time
resolvedAt:
type: string
format: date-time
escalatedAt:
type: string
format: date-time
lastUpdated:
type: string
format: date-time
timelineCount:
type: integer
remediationAttempts:
type: integer
resolution:
type: string
requiresHumanAction:
type: boolean
description: >-
True when the Issue is in Contained state OR carries the
RequiresHumanAction condition. GAP-07 fix promoted this to a
typed status field on the Issue CRD itself so `kubectl get issue
-o jsonpath='{.status.requiresHumanAction}'` works without
parsing conditions.
requiredAction:
type: string
description: >-
Concrete follow-up action the operator must perform when
requiresHumanAction=true (e.g., 'restore the deployment's
replicas to the desired count after fixing the root cause').
GAP-07 fix.
chaosInduced:
type: boolean
description: >-
True when the Issue was correlated with an active
ChaosExperiment at creation time (label
platform.chatcli.io/source=chaos-experiment). GAP-04 fix.
chaosExperiment:
type: string
description: >-
Name of the correlated ChaosExperiment CR when
chaosInduced=true. GAP-04 fix.
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'
NotFound:
description: Resource not found
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
`.
````