Alerts Operations Bulk Acknowledge
Acknowledges each listed alert on its own, under the same rules as the single acknowledge (the alert must be NEW and its expectedVersion must match). The call is not atomic. It answers 200 with one outcome per item, either the updated alert or an errorCode and errorMessage, plus successCount and failureCount, and one item's failure never rolls back or hides the others. items must not be empty (400 otherwise). The analystNote, up to 2048 characters, applies to every item. A summary of the call 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).
The alerts to acknowledge, each with its alertId and expectedVersion, and one optional analystNote of up to 2048 characters that applies to every alert.
Show optional properties
{
"items": [
{
"alertId": 0
}
]
}
{
"items": [
{
"alertId": 1,
"expectedVersion": 1
},
{
"alertId": 2,
"expectedVersion": 1
}
],
"analystNote": "Reviewing the Production Servers alerts together"
}
List of alert items to acknowledge
Optional shared triage note for all acknowledged items
200 OK successful response envelope. One outcome per listed alert; an alert that cannot be acknowledged is reported in its own outcome with an errorCode and the call still answers 200
{
"successCount": 0,
"failureCount": 0,
"results": [
{
"alertId": 0,
"success": false,
"alert": {
"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"
},
"errorCode": "string",
"errorMessage": "string"
}
]
}
Count of successfully processed alerts
Count of failed alerts
Individual result per requested item
400 Bad Request: VALIDATION_FAILED when items is empty, an item has no alertId or analystNote is longer than 2048 characters; MALFORMED_REQUEST when the body cannot be read
{
"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.
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.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"items":["object"]}' https://{api_host}/api/v1/alerts/bulk-acknowledge