Reports Operations Get Ssh Mfa Preview

Reports Operations Get Ssh Mfa Preview
SSH MFA preview metrics

Returns count of SSH challenges and challenged hypervisors. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/reports/ssh-mfa/preview
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 successful response envelope. The count of SSH challenges and of challenged hypervisors in the range

Returns SshMfaPreviewDto of type(s) application/json
{
    "approved": 38,
    "denied": 4,
    "hypervisorsWithFailures": 2,
    "repeatedFailureAlerts": 1,
    "challenged": 45,
    "hypervisorsChallenged": 6,
    "asOf": "2026-01-15T10:00:01Z",
    "windowStart": "2026-01-08T10:00:00Z",
    "windowEnd": "2026-01-15T10:00:00Z"
}
integer As int64 As int64
approved
Required  

Number of SSH MFA Events in the window whose outcome is CHALLENGED or ALLOWED

integer As int64 As int64
denied
Required  

Number of SSH MFA Events in the window whose outcome is CHALLENGE_FAILED or PREVENTED

integer As int64 As int64
hypervisorsWithFailures
Required  

Number of distinct hypervisors with at least one denied SSH MFA Event in the window

integer As int64 As int64
repeatedFailureAlerts
Required  

Number of Alerts created in the window whose rule name starts with SSH MFA, Repeated SSH MFA or MFA, or whose matched Rule name starts with SSH MFA or MFA

integer As int64 As int64
challenged
Required  

Number of all SSH MFA Events in the window, whatever the outcome

integer As int64 As int64
hypervisorsChallenged
Required  

Number of distinct hypervisors with at least one SSH MFA Event in the window

string As date-time As date-time
asOf
Required  

UTC instant the counts were read, taken at query time (slightly after windowEnd)

string As date-time As date-time
windowStart
Required  

UTC start of the window: windowEnd minus 24 hours, 7 days or 30 days

string As date-time As date-time
windowEnd
Required  

UTC end of the window: the time the request was handled


400

400 Bad Request: INVALID_RANGE when range is not exactly 24h, 7d or 30d (lowercase; an empty value, a different letter case or any alias is rejected; omitting range defaults to 7d); the message is "Unsupported time range provided. Valid values are 24h, 7d, 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: 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 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.


500

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

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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/preview