Reports Operations Get Ssh Mfa Preview
Returns count of SSH challenges and challenged hypervisors. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
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.
7d
200 OK successful response envelope. The count of SSH challenges and of challenged hypervisors in the range
{
"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"
}
Number of SSH MFA Events in the window whose outcome is CHALLENGED or ALLOWED
Number of SSH MFA Events in the window whose outcome is CHALLENGE_FAILED or PREVENTED
Number of distinct hypervisors with at least one denied SSH MFA Event in the window
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
Number of all SSH MFA Events in the window, whatever the outcome
Number of distinct hypervisors with at least one SSH MFA Event in the window
UTC instant the counts were read, taken at query time (slightly after windowEnd)
UTC start of the window: windowEnd minus 24 hours, 7 days or 30 days
UTC end of the window: the time the request was handled
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."
{
"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: 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.
500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail
"ApiErrorResponse Object"
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 -H 'Authorization: <value>' https://{api_host}/api/v1/reports/ssh-mfa/preview