Alerts Operations Acknowledge
Moves an alert from NEW to ACKNOWLEDGED, records the acting user and time, and stores the optional analystNote (up to 2048 characters). The body must carry expectedVersion, the version read from the alert. 409 ALERT_INVALID_STATE_TRANSITION unless the alert is NEW, 409 ALERT_VERSION_CONFLICT when expectedVersion is missing or stale (refetch and retry), 404 ALERT_NOT_FOUND. Every success is audited. Requires the ADMIN or SECURITY_OPERATOR role (the AUDITOR role receives 403). Also accepts a Bearer API token with Full access (a Read-only token receives 403 API_TOKEN_NOT_PERMITTED).
Canonical alert ID
1
The version of the alert the caller read, as expectedVersion, and an optional analystNote of up to 2048 characters. A missing or stale expectedVersion is answered 409 ALERT_VERSION_CONFLICT.
{
"analystNote": "Reviewing with the host owner",
"expectedVersion": 1
}
Optional triage or resolution note
Expected optimistic concurrency version
200 OK successful response envelope. The alert after it moved to ACKNOWLEDGED, with its new version
{
"alertId": 0,
"title": "string",
"description": "string",
"alertClass": "string",
"agentPk": 0,
"hostname": "string",
"groupName": "string",
"currentGroupName": "string",
"severity": 0,
"eventUuid": "string",
"eventIngestTime": "string",
"alertRuleId": 0,
"alertRuleName": "string",
"alertRuleRevision": 0,
"qualificationSnapshot": "string",
"matchedRulePk": 0,
"matchedRuleName": "string",
"matchedRuleAction": "string",
"matchedRuleRevision": 0,
"matchedRules": [
{
"ruleId": 0,
"name": "string",
"action": "string",
"revision": 0,
"builtIn": false,
"firstMatchedAt": "string"
}
],
"mode": "string",
"outcome": "string",
"eventCount": 0,
"state": "string",
"resolutionReason": "string",
"version": 0,
"analystNote": "string",
"actedBy": 0,
"actedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"firstSeenAt": "string",
"lastSeenAt": "string"
}
Unique canonical alert identifier
Human-readable incident title
Optional narrative description
High-level architectural domain of the alert
SECURITY: Raised by the alert engine when the threshold of an Alert Rule is breached by Agent events; carries the number of eventsSYSTEM_HEALTH: Raised by the console itself rather than by Agent events; today only the per-license expiration alerts of the built-in license rule. It has no events, so its event count is always 0
Database primary key of the associated agent, if applicable
Hostname of the affected agent
Security Group the alert was raised under: the Group the agent was in when the alert's first event arrived, kept on the alert so moving the agent does not change it. While that Group still exists this is its current name, so a rename is not a move. Alerts raised before this was recorded fall back to the agent's current Group. Null for license alerts, which have no agent
Security Group the agent is in now; differs from groupName once the agent has been moved to another Group. Null when the alert has no agent or the agent has no Group
Alert severity score from 1 to 100; present only for license-expiration alerts, null for security alerts
UUID of the originating security event for deep-linking
Ingest timestamp partition key of the originating event
ID of the Alert Rule that qualified this incident
Name snapshot of the Alert Rule
Revision snapshot of the Alert Rule
JSON snapshot of the qualification criteria
Primary key of the matched protection rule if applicable
Name snapshot of the matched protection rule
Action of the matched Rule at the time the Alert was opened: ALLOW, BLOCK, AUDIT or MFA_REQUIRED; null when the Alert has no matched Rule, including system-health alerts
Revision snapshot of the matched protection rule
Every distinct protection Rule that matched a qualifying event of this alert, ordered by firstMatchedAt ascending (ties by name). Never empty for an alert that names a Rule: an alert with nothing stored yet lists the one Rule it names. Empty when no Rule matched and for license and system-health alerts. matchedRuleName and the other matchedRule fields still describe the Rule of the latest qualifying event
Group mode when received, captured when the Alert was opened (UI label: Group mode when received; it can differ from the mode at login): MONITOR or ENFORCE; null for a system-health alert
Outcome of the event that opened the Alert: one of ALLOWED, DETECTED_OBSERVE, PREVENTED, TERMINATED, ERROR, CHALLENGED or CHALLENGE_FAILED; null for a system-health alert
Number of aggregated events in this incident
Current state in the alert investigation lifecycle
NEW: Raised and not yet handled; the state of every new alert. It can be acknowledged, resolved or marked false positiveACKNOWLEDGED: Acknowledged by an operator (possible only from NEW). Still active and still counted in the active count; it can still be resolved or marked false positiveRESOLVED: Closed by the resolve or mark-false-positive action, or by the console resolving a license alert itself. The only terminal state; the resolution reason says which
Resolution disposition if state is RESOLVED
Optimistic locking version
Analyst notes recorded during triage or resolution
User ID of the actor who transitioned the alert state
Timestamp of the most recent lifecycle transition
Timestamp when the incident was created
Timestamp when the incident was last modified
Timestamp when the first event in this incident occurred
Timestamp when the latest event in this incident occurred
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: ALERT_NOT_FOUND when no alert has the id; RESOURCE_NOT_FOUND when the alertId is not a number, because the route only matches digits
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
409 Conflict: ALERT_INVALID_STATE_TRANSITION when the alert is not in the state NEW; ALERT_VERSION_CONFLICT when expectedVersion is missing or is not the current version of the alert, or another caller changed the alert first
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v1/alerts/{alertId}/acknowledge