Acknowledge Alert

Acknowledge a single Cannonball alert

POST /api/v1/cannonball/alerts/{id}/acknowledge/

Acknowledges a single alert, marking it as reviewed by the user.

Path Parameters

ParameterTypeDescription
idintegerAlert ID to acknowledge

Request Body

No request body required.

Response

{
  "id": 1,
  "session": 1,
  "session_icao": "A12345",
  "session_callsign": "N123HP",
  "alert_type": "le_detected",
  "priority": "warning",
  "title": "Law Enforcement Aircraft Detected",
  "message": "LAPD helicopter N123HP detected 2.5nm to the northeast, altitude 1500ft, circling pattern detected.",
  "aircraft_lat": 34.0522,
  "aircraft_lon": -118.2437,
  "aircraft_altitude": 1500,
  "user_lat": 34.0400,
  "user_lon": -118.2500,
  "distance_nm": 2.5,
  "bearing": 45.0,
  "pattern": 1,
  "notified": true,
  "announced": true,
  "acknowledged": true,
  "acknowledged_at": "2024-01-15T12:35:00Z",
  "created_at": "2024-01-15T12:30:00Z"
}

Response Fields

FieldTypeDescription
idintegerAlert ID
sessionintegerAssociated session ID
session_icaostringAircraft ICAO hex code
session_callsignstringAircraft callsign
alert_typestringType of alert
prioritystringAlert priority
titlestringAlert title
messagestringDetailed alert message
aircraft_latfloatAircraft latitude at time of alert
aircraft_lonfloatAircraft longitude at time of alert
aircraft_altitudeintegerAircraft altitude at time of alert
user_latfloatUser latitude at time of alert
user_lonfloatUser longitude at time of alert
distance_nmfloatDistance from user at time of alert
bearingfloatBearing from user at time of alert
patternintegerAssociated pattern ID (if applicable)
notifiedbooleanWhether push notification was sent
announcedbooleanWhether TTS announcement was made
acknowledgedbooleanTrue after acknowledgement
acknowledged_atstringAcknowledgement timestamp
created_atstringAlert creation timestamp

Example Request

curl -X POST "https://api.skyspy.io/api/v1/cannonball/alerts/1/acknowledge/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Codes

CodeDescription
200Alert acknowledged successfully
404Alert not found
401Unauthorized - Invalid or missing authentication