Overview
Adds or updates notes for a specific alert. Notes allow analysts to document observations, investigations, or remediation steps related to an alert. Supports auditing for traceability.Authorization Required: Include a valid Bearer Token in the Authorization header.
Endpoint Details
POST /api/utm-alerts/notes
Method: POST
Content-Type: application/json
Authentication: Bearer Token required
Query Parameter: alertId (required)
Content-Type: application/json
Authentication: Bearer Token required
Query Parameter: alertId (required)
Parameters
Query Parameters
string
required
UUID of the alert to update with notes
Request Body
The request body should contain the notes as a plain JSON string.string
Text notes for the alert. Can be empty to clear existing notes.
Request & Response Examples
Additional Code Examples
Response Details
Successful Response
- Success
- Empty Notes
Status Codes
OK
Notes updated successfully
Bad Request
Invalid alert ID format or malformed request body
Unauthorized
Missing or invalid Bearer token
Not Found
Alert not found with the specified ID
Internal Server Error
Internal server error while updating notes
Common Use Cases
Investigation Notes
False Positive Documentation
Escalation Notes
Clear Notes
Best Practices
Note Content Guidelines
Note Content Guidelines
Structured Documentation:
- Include timestamp and analyst name
- Describe investigation steps taken
- Document evidence found or lack thereof
- Specify next actions or resolution
- Use clear, professional language
False Positive Handling
False Positive Handling
Best Practices:
- Clearly mark as “FALSE POSITIVE”
- Explain the root cause
- Document prevention measures taken
- Reference any rules or exceptions added
- Include confidence level in assessment
Investigation Workflow
Investigation Workflow
Recommended Flow:
- Initial triage notes with priority assessment
- Investigation progress updates
- Evidence collection documentation
- Final resolution and lessons learned
- Handoff notes if escalating to other teams