Alerts Operations Bulk Resolve

Alerts Operations Bulk Resolve
Resolve multiple alerts in one request. Not one atomic batch by design - each item's own outcome is reported independently in the 200 response body, never rolled back by another item's failure

Resolves each listed alert on its own, under the same rules as the single resolve (the alert must be NEW or ACKNOWLEDGED 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. An alert that is already resolved is reported as ALERT_INVALID_STATE_TRANSITION in its own outcome. 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).

Request
URI
POST
https://{api_host}/api/v1/alerts/bulk-resolve
COPY
Request Body

The alerts to resolve, each with its alertId and expectedVersion, and one optional analystNote of up to 2048 characters that applies to every alert.

AlertBulkResolveRequest of type(s) application/json
Required  

Show optional properties

{
    "items": [
        {
            "alertId": 0
        }
    ]
}
{
    "items": [
        {
            "alertId": 1,
            "expectedVersion": 1
        },
        {
            "alertId": 2,
            "expectedVersion": 2
        }
    ],
    "analystNote": "Confirmed benign after review of the Production Servers alerts"
}
array of object
items
Required  

List of alert items to resolve

string
analystNote
Optional

Optional shared resolution note for all resolved items

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. One outcome per listed alert; an alert that cannot be resolved is reported in its own outcome with an errorCode and the call still answers 200

Returns AlertBulkActionResponse of type(s) application/json
{
    "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"
        }
    ]
}
integer As int32 As int32
successCount
Required  

Count of successfully processed alerts

integer As int32 As int32
failureCount
Required  

Count of failed alerts

array of object
results
Required  

Individual result per requested item


400

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

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

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)

Returns ForbiddenWrite of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"items":["object"]}' https://{api_host}/api/v1/alerts/bulk-resolve