Alerts Operations Export Csv

Alerts Operations Export Csv
Export every alert that matches the search filters as CSV

CSV of every security and license-expiration alert that matches the search filters (the same filters as /api/v1/alerts/search), not paginated and in ascending alertId order. The rows are read in one consistent snapshot taken when the export starts, so alerts created, changed or deleted during the export neither appear twice nor go missing. The response is text/csv with charset UTF-8, sent as an attachment named alerts-export-all-YYYY-MM-DD.csv (the current UTC date) with caching disabled. The first line is the header row, in this order, Alert ID, Title, Class, Severity, Hypervisor, Group, Matched Rule, Action, Group mode when received, Outcome, Events, State, Resolution, Created At, Updated At, Matched Rule Count, Matched Rules. The last two columns are new trailing columns; the earlier columns and their order are unchanged. Matched Rule Count is the number of distinct Rules that matched the alert, and Matched Rules is every Rule name joined with '; ' in the order the Rules first matched (the one Rule the alert names when none are stored). Alert ID, Severity, Events and Matched Rule Count are unquoted numbers (Severity is empty when absent); the other columns are enclosed in double quotes with embedded quotes doubled, and a value whose first non-space character is =, +, -, @, tab, CR or LF is prefixed with a single quote. Created At and Updated At are ISO-8601 UTC instants. An unknown state, groupMode or runtimeOutcome answers 400 INVALID_FILTER before any CSV is written. A failure after streaming has started aborts the connection, so the download fails instead of ending early. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role. Every attempt is audited (ALERTS_EXPORTED with the row count, or ALERTS_EXPORT_FAILED).

Request
URI
GET
https://{api_host}/api/v1/alerts/export
COPY
Query Parameters
string
search
Optional

Search term matching title, hostname, Alert Rule, matched protection Rule or any Rule that contributed to the alert (case-insensitive substring of the Rule name), the Security Group the alert was raised under, or the agent's current Security Group name

search example
backup-agent
string
state
Optional

Lifecycle state filter

state example
NEW
integer
agentPk
Optional

Filter by agent primary key

agentPk example
2
integer
alertRuleId
Optional

Filter by Alert Rule ID

alertRuleId example
1
string
groupMode
Optional

Filter by the alert's own snapshotted enforcement mode (MONITOR, ENFORCE)

groupMode example
ENFORCE
string
runtimeOutcome
Optional

Filter by the Runtime outcome shown for each alert. Display-category tokens (what the Alerts page labels each row, derived from the recorded outcome and matched rule action): OBSERVED_ONLY (Observed only: detected but not prevented, or no recorded outcome and no blocking action), BLOCKED (Blocked: PREVENTED or TERMINATED, or no recorded outcome with a Block rule in an ENFORCE Group), ALLOWED_PLAIN (Allowed: ALLOWED, or an Allow rule, but not Audit or MFA required), AUDIT (Audit: allowed by an Audit rule), MFA_REQUIRED (MFA required: allowed by an MFA-required rule). The categories partition the alerts. Raw stored-outcome tokens are still accepted and match the recorded outcome exactly: ALLOWED, DETECTED_OBSERVE, PREVENTED, TERMINATED, ERROR, CHALLENGED, CHALLENGE_FAILED. Tokens are case-insensitive; the two vocabularies share no token, and ALLOWED is the raw outcome, not the Allowed category

runtimeOutcome example
PREVENTED
string
since
Optional

Start timestamp filter, ISO 8601 date-time with an offset (for example 2026-01-15T09:30:00Z); any offset is accepted

since example
2026-01-15T09:30:00Z
string
until
Optional

End timestamp filter, ISO 8601 date-time with an offset (for example 2026-01-15T09:30:00Z); any offset is accepted

until example
2026-01-16T09:30:00Z

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK CSV file stream. Every matching alert, sent as an attachment named alerts-export-all-YYYY-MM-DD.csv

"Alert ID,Title,Class,Severity,Hypervisor,Group,Matched Rule,Action,Group mode when received,Outcome,Events,State,Resolution,Created At,Updated At\n1001,\"Repeated failed SSH login on esx-prod-node01.vtp.local\",\"SECURITY\",,\"esx-prod-node01.vtp.local\",\"Production\",\"Lock command\",\"BLOCK\",\"ENFORCE\",\"PREVENTED\",3,\"NEW\",\"\",\"2026-09-30T09:17:05Z\",\"2026-09-30T09:27:05Z\"\n"

400

400 Bad Request: INVALID_FILTER when state, groupMode or runtimeOutcome is not a known value; INVALID_ARGUMENT when since or until is not an ISO-8601 date-time or a numeric parameter is not a number

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; 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 ForbiddenRead 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 -H 'Authorization: <value>' https://{api_host}/api/v1/alerts/export