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
getFirewallDetailsV1()	GET /api/vps/v1/firewall/{firewallId}	Get firewall details
getFirewallListV1()	GET /api/vps/v1/firewall	Get firewall list
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

Activate a firewall for a specified virtual machine. Only one firewall can be active for a virtual machine at a time. Use this endpoint to apply firewall rules to VPS instances.

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

Create new firewall rule for 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 lose sync with the firewall and will have to be synced again manually. Use this endpoint to add new security rules to firewalls.

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

Create a new firewall. Use this endpoint to set up new firewall configurations for VPS security.

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

Deactivate a firewall for a specified virtual machine. Use this endpoint to remove firewall protection from VPS instances.

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

Delete a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to remove specific firewall rules.

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

Delete a specified firewall. Any virtual machine that has this firewall activated will automatically have it deactivated. Use this endpoint to remove unused firewall configurations.

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]

`getFirewallDetailsV1()`

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

Get firewall details

Retrieve firewall by its ID and rules associated with it. Use this endpoint to view specific firewall configuration and rules.

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->getFirewallDetailsV1($firewallId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VPSFirewallApi->getFirewallDetailsV1: ', $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]

`getFirewallListV1()`

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

Get firewall list

Retrieve all available firewalls. Use this endpoint to view existing firewall configurations.

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\VPSV1FirewallListResponse

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

`syncFirewallV1()`

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

Sync firewall

Sync a firewall for a specified virtual machine. Firewall can lose sync with virtual machine if the firewall has new rules added, removed or updated. Use this endpoint to apply updated firewall rules to VPS instances.

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

Update a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to modify existing firewall rules.

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]

FilesExpand file tree

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

getFirewallDetailsV1()

Example

Parameters

Return type

getFirewallListV1()

Example

Parameters

Return type

syncFirewallV1()

Example

Parameters

Return type

updateFirewallRuleV1()

Example

Parameters

Return type

`activateFirewallV1()`

`createFirewallRuleV1()`

`createNewFirewallV1()`

`deactivateFirewallV1()`

`deleteFirewallRuleV1()`

`deleteFirewallV1()`

`getFirewallDetailsV1()`

`getFirewallListV1()`

`syncFirewallV1()`

`updateFirewallRuleV1()`