Skip to main content
GET
/
api
/
v1
/
incidents
/
{name}
/
remediation
Get Incident Remediation
curl --request GET \
  --url https://api.example.com/api/v1/incidents/{name}/remediation
{
  "apiVersion": "v1",
  "kind": "Remediation",
  "metadata": {
    "name": "INC-20260319-001",
    "namespace": "production"
  },
  "spec": {
    "runbook": "runbook-oomkill-standard",
    "strategy": "automated",
    "approvalRequired": true,
    "rollbackOnFailure": true
  },
  "status": {
    "phase": "PendingApproval",
    "steps": [
      {
        "name": "diagnose-memory-usage",
        "description": "Collect container memory usage metrics",
        "status": "Completed",
        "startedAt": "2026-03-19T15:20:30Z",
        "completedAt": "2026-03-19T15:20:45Z",
        "output": "Uso medio: 498Mi/512Mi (97.2%)"
      },
      {
        "name": "patch-resource-limits",
        "description": "Update Deployment memory limit to 1Gi",
        "status": "PendingApproval",
        "approvalName": "APR-20260319-001"
      },
      {
        "name": "verify-stability",
        "description": "Verify pod stability after patch",
        "status": "Pending"
      },
      {
        "name": "update-hpa",
        "description": "Adjust HPA for the new resource configuration",
        "status": "Pending"
      }
    ],
    "estimatedDuration": "5m",
    "riskLevel": "medium",
    "preflightSnapshot": {
      "resourceKind": "Deployment",
      "resourceName": "checkout-service",
      "namespace": "production",
      "replicas": 3,
      "containerImages": {"app": "ghcr.io/myorg/checkout:v2.1.0"},
      "containerResources": {
        "app": {"cpuRequest": "200m", "cpuLimit": "1000m", "memoryRequest": "256Mi", "memoryLimit": "512Mi"}
      },
      "hpaMinReplicas": 2,
      "hpaMaxReplicas": 8,
      "capturedAt": "2026-03-19T15:20:25Z"
    },
    "actionCheckpoints": [
      {"actionIndex": 0, "actionType": "diagnose-memory-usage", "success": true, "timestamp": "2026-03-19T15:20:30Z"},
      {"actionIndex": 1, "actionType": "patch-resource-limits", "success": false, "timestamp": "2026-03-19T15:20:50Z"}
    ],
    "rollbackPerformed": false,
    "postFailureHealthy": null
  }
}
name
string
required
Unique incident name (e.g., INC-20260319-001)
{
  "apiVersion": "v1",
  "kind": "Remediation",
  "metadata": {
    "name": "INC-20260319-001",
    "namespace": "production"
  },
  "spec": {
    "runbook": "runbook-oomkill-standard",
    "strategy": "automated",
    "approvalRequired": true,
    "rollbackOnFailure": true
  },
  "status": {
    "phase": "PendingApproval",
    "steps": [
      {
        "name": "diagnose-memory-usage",
        "description": "Collect container memory usage metrics",
        "status": "Completed",
        "startedAt": "2026-03-19T15:20:30Z",
        "completedAt": "2026-03-19T15:20:45Z",
        "output": "Uso medio: 498Mi/512Mi (97.2%)"
      },
      {
        "name": "patch-resource-limits",
        "description": "Update Deployment memory limit to 1Gi",
        "status": "PendingApproval",
        "approvalName": "APR-20260319-001"
      },
      {
        "name": "verify-stability",
        "description": "Verify pod stability after patch",
        "status": "Pending"
      },
      {
        "name": "update-hpa",
        "description": "Adjust HPA for the new resource configuration",
        "status": "Pending"
      }
    ],
    "estimatedDuration": "5m",
    "riskLevel": "medium",
    "preflightSnapshot": {
      "resourceKind": "Deployment",
      "resourceName": "checkout-service",
      "namespace": "production",
      "replicas": 3,
      "containerImages": {"app": "ghcr.io/myorg/checkout:v2.1.0"},
      "containerResources": {
        "app": {"cpuRequest": "200m", "cpuLimit": "1000m", "memoryRequest": "256Mi", "memoryLimit": "512Mi"}
      },
      "hpaMinReplicas": 2,
      "hpaMaxReplicas": 8,
      "capturedAt": "2026-03-19T15:20:25Z"
    },
    "actionCheckpoints": [
      {"actionIndex": 0, "actionType": "diagnose-memory-usage", "success": true, "timestamp": "2026-03-19T15:20:30Z"},
      {"actionIndex": 1, "actionType": "patch-resource-limits", "success": false, "timestamp": "2026-03-19T15:20:50Z"}
    ],
    "rollbackPerformed": false,
    "postFailureHealthy": null
  }
}
{
  "apiVersion": "v1",
  "kind": "Error",
  "error": {
    "code": 404,
    "message": "Remediation not found",
    "details": "No remediation plan has been generated for incident 'INC-20260319-001'"
  }
}