Hostinger\VPSFirewallApi

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

Method	HTTP request	Description
activateFirewallV1()	POST /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}	Activate firewall
createFirewallRuleV1()	POST /api/vps/v1/firewall/{firewallId}/rules	Create firewall rule
createNewFirewallV1()	POST /api/vps/v1/firewall	Create new firewall
deactivateFirewallV1()	POST /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}	Deactivate firewall
deleteFirewallRuleV1()	DELETE /api/vps/v1/firewall/{firewallId}/rules/{ruleId}	Delete firewall rule
deleteFirewallV1()	DELETE /api/vps/v1/firewall/{firewallId}	Delete firewall
getFirewallListV1()	GET /api/vps/v1/firewall	Get firewall list
getFirewallV1()	GET /api/vps/v1/firewall/{firewallId}	Get firewall
syncFirewallV1()	POST /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}	Sync firewall
updateFirewallRuleV1()	PUT /api/vps/v1/firewall/{firewallId}/rules/{ruleId}	Update firewall rule

`activateFirewallV1()`

activateFirewallV1($firewallId, $virtualMachineId): \Hostinger\Model\VPSV1ActionActionResource

Activate firewall

This endpoint activates a firewall for a specified virtual machine. Only one firewall can be active for a virtual machine at a time.

Example

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


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


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

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

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID
virtualMachineId	int	Virtual Machine ID

Return type

\Hostinger\Model\VPSV1ActionActionResource

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

`createFirewallRuleV1()`

createFirewallRuleV1($firewallId, $vPSV1FirewallRulesStoreRequest): \Hostinger\Model\VPSV1FirewallFirewallRuleResource

Create firewall rule

This endpoint creates new firewall rule from a specified firewall. By default, the firewall drops all incoming traffic, which means you must add accept rules for all ports you want to use. Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$firewallId = 9449049; // int | Firewall ID
$vPSV1FirewallRulesStoreRequest = new \Hostinger\Model\VPSV1FirewallRulesStoreRequest(); // \Hostinger\Model\VPSV1FirewallRulesStoreRequest

try {
    $result = $apiInstance->createFirewallRuleV1($firewallId, $vPSV1FirewallRulesStoreRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSFirewallApi->createFirewallRuleV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID
vPSV1FirewallRulesStoreRequest	\Hostinger\Model\VPSV1FirewallRulesStoreRequest

Return type

\Hostinger\Model\VPSV1FirewallFirewallRuleResource

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

`createNewFirewallV1()`

createNewFirewallV1($vPSV1FirewallStoreRequest): \Hostinger\Model\VPSV1FirewallFirewallResource

Create new firewall

This endpoint creates a new firewall.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$vPSV1FirewallStoreRequest = new \Hostinger\Model\VPSV1FirewallStoreRequest(); // \Hostinger\Model\VPSV1FirewallStoreRequest

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

Parameters

Name	Type	Description	Notes
vPSV1FirewallStoreRequest	\Hostinger\Model\VPSV1FirewallStoreRequest

Return type

\Hostinger\Model\VPSV1FirewallFirewallResource

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

`deactivateFirewallV1()`

deactivateFirewallV1($firewallId, $virtualMachineId): \Hostinger\Model\VPSV1ActionActionResource

Deactivate firewall

This endpoint deactivates a firewall for a specified virtual machine.

Example

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


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


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

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

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID
virtualMachineId	int	Virtual Machine ID

Return type

\Hostinger\Model\VPSV1ActionActionResource

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

`deleteFirewallRuleV1()`

deleteFirewallRuleV1($firewallId, $ruleId): \Hostinger\Model\CommonSuccessEmptyResource

Delete firewall rule

This endpoint deletes a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$firewallId = 9449049; // int | Firewall ID
$ruleId = 8941182; // int | Firewall Rule ID

try {
    $result = $apiInstance->deleteFirewallRuleV1($firewallId, $ruleId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSFirewallApi->deleteFirewallRuleV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID
ruleId	int	Firewall Rule ID

Return type

\Hostinger\Model\CommonSuccessEmptyResource

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

`deleteFirewallV1()`

deleteFirewallV1($firewallId): \Hostinger\Model\CommonSuccessEmptyResource

Delete firewall

This endpoint deletes a specified firewall. Any virtual machine that has this firewall activated will automatically have it deactivated.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$firewallId = 9449049; // int | Firewall ID

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

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID

Return type

\Hostinger\Model\CommonSuccessEmptyResource

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

`getFirewallListV1()`

getFirewallListV1($page): \Hostinger\Model\VPSGetFirewallListV1200Response

Get firewall list

This endpoint retrieves a list of all firewalls available.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$page = 1; // int | Page number

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

Parameters

Name	Type	Description	Notes
page	int	Page number	[optional]

Return type

\Hostinger\Model\VPSGetFirewallListV1200Response

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

`getFirewallV1()`

getFirewallV1($firewallId): \Hostinger\Model\VPSV1FirewallFirewallResource

Get firewall

This endpoint retrieves firewall by its ID and rules associated with it.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$firewallId = 9449049; // int | Firewall ID

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

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID

Return type

\Hostinger\Model\VPSV1FirewallFirewallResource

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

`syncFirewallV1()`

syncFirewallV1($firewallId, $virtualMachineId): \Hostinger\Model\VPSV1ActionActionResource

Sync firewall

This endpoint syncs a firewall for a specified virtual machine. Firewall can loose sync with virtual machine if the firewall has new rules added, removed or updated.

Example

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


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


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

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

Parameters

Name	Type	Description	Notes
firewallId	int	Firewall ID
virtualMachineId	int	Virtual Machine ID

Return type

\Hostinger\Model\VPSV1ActionActionResource

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

`updateFirewallRuleV1()`

updateFirewallRuleV1($firewallId, $ruleId, $vPSV1FirewallRulesStoreRequest): \Hostinger\Model\VPSV1FirewallFirewallRuleResource

Update firewall rule

This endpoint updates a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will loose sync with the firewall and will have to be synced again manually.

Example

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


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


$apiInstance = new Hostinger\Api\VPSFirewallApi(config: $config);
$firewallId = 9449049; // int | Firewall ID
$ruleId = 8941182; // int | Firewall Rule ID
$vPSV1FirewallRulesStoreRequest = new \Hostinger\Model\VPSV1FirewallRulesStoreRequest(); // \Hostinger\Model\VPSV1FirewallRulesStoreRequest

try {
    $result = $apiInstance->updateFirewallRuleV1($firewallId, $ruleId, $vPSV1FirewallRulesStoreRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSFirewallApi->updateFirewallRuleV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
firewallId	int	Firewall ID
ruleId	int	Firewall Rule ID
vPSV1FirewallRulesStoreRequest	\Hostinger\Model\VPSV1FirewallRulesStoreRequest

Return type

\Hostinger\Model\VPSV1FirewallFirewallRuleResource

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

Files

VPSFirewallApi.md

Latest commit

History

VPSFirewallApi.md

File metadata and controls

Hostinger\VPSFirewallApi

activateFirewallV1()

Example

Parameters

Return type

createFirewallRuleV1()

Example

Parameters

Return type

createNewFirewallV1()

Example

Parameters

Return type

deactivateFirewallV1()

Example

Parameters

Return type

deleteFirewallRuleV1()

Example

Parameters

Return type

deleteFirewallV1()

Example

Parameters

Return type

getFirewallListV1()

Example

Parameters

Return type

getFirewallV1()

Example

Parameters

Return type

syncFirewallV1()

Example

Parameters

Return type

updateFirewallRuleV1()

Example

Parameters

Return type

`activateFirewallV1()`

`createFirewallRuleV1()`

`createNewFirewallV1()`

`deactivateFirewallV1()`

`deleteFirewallRuleV1()`

`deleteFirewallV1()`

`getFirewallListV1()`

`getFirewallV1()`

`syncFirewallV1()`

`updateFirewallRuleV1()`