VPSMalwareScannerApi.md

Hostinger\VPSMalwareScannerApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method	HTTP request	Description
getScanMetricsV1()	GET /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Get scan metrics
installMonarxV1()	POST /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Install Monarx
uninstallMonarxV1()	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Uninstall Monarx

getScanMetricsV1()

getScanMetricsV1($virtualMachineId): \Hostinger\Model\VPSV1MalwareMetricsResource

Get scan metrics

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSMalwareScannerApi(config: $config);
$virtualMachineId = 1268054; // int | Virtual Machine ID

try {
    $result = $apiInstance->getScanMetricsV1($virtualMachineId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSMalwareScannerApi->getScanMetricsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
virtualMachineId	int	Virtual Machine ID

Return type

\Hostinger\Model\VPSV1MalwareMetricsResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

installMonarxV1()

installMonarxV1($virtualMachineId): \Hostinger\Model\VPSV1ActionActionResource

Install Monarx

This endpoint installs the Monarx malware scanner on a specified virtual machine. Monarx is a security tool designed to detect and prevent malware infections on virtual machines. By installing Monarx, users can enhance the security of their virtual machines, ensuring that they are protected against malicious software.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSMalwareScannerApi(config: $config);
$virtualMachineId = 1268054; // int | Virtual Machine ID

try {
    $result = $apiInstance->installMonarxV1($virtualMachineId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSMalwareScannerApi->installMonarxV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
virtualMachineId	int	Virtual Machine ID

Return type

\Hostinger\Model\VPSV1ActionActionResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]

uninstallMonarxV1()

uninstallMonarxV1($virtualMachineId): \Hostinger\Model\VPSV1ActionActionResource

Uninstall Monarx

This endpoint uninstalls the Monarx malware scanner on a specified virtual machine. If Monarx is not installed, the request will still be processed without any effect.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\VPSMalwareScannerApi(config: $config);
$virtualMachineId = 1268054; // int | Virtual Machine ID

try {
    $result = $apiInstance->uninstallMonarxV1($virtualMachineId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSMalwareScannerApi->uninstallMonarxV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
virtualMachineId	int	Virtual Machine ID

Return type

\Hostinger\Model\VPSV1ActionActionResource

[Back to top] [Back to API list] [Back to Model list] [Back to README]