v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
VPS: Malware scanner

Get scan metrics

Retrieve scan metrics for the Monarx malware scanner installed on a specified virtual machine.

The scan metrics provide detailed information about malware scans performed by Monarx, including number of scans, detected threats, and other relevant statistics. This information is useful for monitoring security status of the virtual machine and assessing effectiveness of the malware scanner.

Use this endpoint to monitor VPS security scan results and threat detection.

get/api/vps/v1/virtual-machines/{virtualMachineId}/monarx

Path parameters

virtualMachineIdinteger required
Example:1268054

Virtual Machine ID

Response

Success response

recordsinteger

Records found during last scan

maliciousinteger

Malicious files found during last scan

compromisedinteger

Compromised files found during last scan

scanned_filesinteger

Total number of files scanned during last scan

scan_started_atstring date-time
scan_ended_atstring date-time nullable

Example response

{
  "records": 1,
  "malicious": 2,
  "compromised": 3,
  "scanned_files": 193218,
  "scan_started_at": "2025-02-27T11:54:22Z",
  "scan_ended_at": "2025-03-27T11:54:22Z"
}