Reports Operations Export Ssh Mfa

Reports Operations Export Ssh Mfa
SSH MFA CSV report export

Streams a CSV export of hypervisors with SSH MFA challenges. The response is text/csv with charset UTF-8, sent as an attachment named ssh-mfa-report-YYYY-MM-DD.csv (the date is the current UTC date) with caching disabled. The first line is the column header row, in this order, hostname, challenged_events, denied_events, last_denied. There is one row for each agent host that has at least one SSH MFA event ingested inside the range window, ordered by challenged_events descending and then by hostname. The challenged_events column counts the CHALLENGED and ALLOWED outcomes, denied_events counts the CHALLENGE_FAILED and PREVENTED outcomes, and last_denied is the ISO-8601 UTC time of the latest denied event (an empty quoted value when there is none). The hostname and last_denied columns are always enclosed in double quotes with embedded quotes doubled, and a text value whose first non-space character is =, +, -, @, tab, CR or LF is prefixed with a single quote to neutralise spreadsheet formulas. The range query parameter accepts 24h, 7d or 30d and defaults to 7d, and any other value is rejected with 400 INVALID_RANGE. There is no row limit. Requires the ADMIN or SECURITY_OPERATOR role (the AUDITOR role receives 403, although it may use the preview). Every export attempt is audited (REPORT_EXPORTED on success, REPORT_EXPORT_FAILED on a denied or failed attempt).

Request
URI
GET
https://{api_host}/api/v1/reports/ssh-mfa/export
COPY
Query Parameters
range
Optional

Time window counted back from the request time: 24h, 7d or 30d (default 7d). Only these exact lowercase values are accepted; any other value, including an empty one, answers 400 INVALID_RANGE.

range example
7d

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK CSV file stream. The CSV of hypervisors with SSH MFA challenges, sent as an attachment named ssh-mfa-report-YYYY-MM-DD.csv

"hostname,challenged_events,denied_events,last_denied\n\"esx01.example.com\",42,3,\"2026-01-15T09:30:00Z\"\n\"esx02.example.com\",17,0,\"\"\n"

400

400 Bad Request: INVALID_RANGE when range is not a supported value (24h, 7d or 30d)

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.


500

500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail

Returns InternalError 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/reports/ssh-mfa/export