알림 API

목록

알림 목록 조회

알림 목록을 페이지네이션하여 가져옵니다. resolved를 지정하지 않으면 열려 있는 알림만 반환합니다. 해제된 이력을 보려면 resolved=true를 지정하세요.

요청

GET /api/alerts/

쿼리 파라미터

응답

{
  "count": 1,
  "current": 1,
  "next": null,
  "previous": null,
  "last": 1,
  "results": [
    {
      "id": "9a1c0b62-9f3a-4a3d-8a1e-2b0f2c6d5e41",
      "alert_type": "metric_threshold",
      "server": {
        "id": "7c5e2a41-6b90-4c33-a7d8-0e5f1b2c3d44",
        "name": "web-01",
        "os": "ubuntu",
        "platform": "linux",
        "is_connected": true,
        "is_deleted": false
      },
      "severity": "warning",
      "title": "CPU usage 92% ≥ 80% for 5 minutes",
      "description": "CPU usage has stayed at or above 80% since 12:00.",
      "dedup_key": "metric:cpu-usage:",
      "device": "",
      "rule": { "id": "4f2b18d0-5c77-4a0b-9d2e-1f7a3c9b4e05", "name": "cpu-high" },
      "condition": "threshold",
      "is_acknowledged": false,
      "action_type": null,
      "added_at": "2026-09-01T12:00:00Z",
      "updated_at": "2026-09-01T12:04:00Z",
      "resolved_at": null,
      "resolution_cause": "",
      "deliveries": [
        {
          "edge": "raised",
          "channel": "email",
          "state": "sent",
          "recipients": 3,
          "at": "2026-09-01T12:02:00Z"
        },
        {
          "edge": "raised",
          "channel": "slack_channel",
          "state": "sent",
          "recipients": null,
          "at": "2026-09-01T12:02:00Z"
        }
      ]
    }
  ]
}

메일 워커 안에서 SMTP 단계를 지난 뒤에 실패한 경우는 여기서 보이지 않고 여전히 sent로 남습니다. 이 필드는 최종 수신함 도착 여부가 아니라 발송자가 확인할 수 있는 범위까지만 알려줍니다.

필요한 스코프: alert:read

예시

curl -X GET "https://your-workspace.ap1.alpacon.io/api/alerts/?resolved=true&severity=critical" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\""

조회

알림 상세 조회

특정 알림을 ID로 조회합니다. 알림이 열려 있든 해제됐든 조회할 수 있습니다. resolved는 목록만 좁힐 뿐, 상세 조회에는 영향을 주지 않습니다.

요청

GET /api/alerts/{alert_id}/

경로 파라미터

응답

알림 목록 조회의 results[] 항목과 같은 스키마입니다.

필요한 스코프: alert:read

예시

curl -X GET "https://your-workspace.ap1.alpacon.io/api/alerts/9a1c0b62-9f3a-4a3d-8a1e-2b0f2c6d5e41/" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\""

확인 처리

알림 확인 처리

이 알림을 확인했다는 것을 기록합니다. 확인(checked)했는지, 무시(dismissed)했는지를 남깁니다. (알림, 사용자) 조합당 확인 처리는 한 번만 가능하며, 같은 알림을 다시 확인 처리하려고 하면 거부됩니다.

요청

POST /api/alerts/{alert_id}/acknowledge/

경로 파라미터

요청 본문

{
  "action_type": "checked"
}

요청 파라미터

응답

{
  "message": "Alert checked successfully"
}

상태 코드 201 Created를 반환합니다. 같은 사용자가 같은 알림을 다시 확인 처리하려고 하면 alert_already_acknowledged로 거부됩니다. 재발생한 알림은 별도의 id를 가진 새 행이므로 다시 확인 처리할 수 있습니다.

필요한 스코프: alert:acknowledge

예시

curl -X POST "https://your-workspace.ap1.alpacon.io/api/alerts/9a1c0b62-9f3a-4a3d-8a1e-2b0f2c6d5e41/acknowledge/" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\"" \
  -H "Content-Type: application/json" \
  -d '{"action_type": "checked"}'