hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Billing/Invoice/
- Billing/Payment/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Server/
- Cloud/Template/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/Services/
- Network/DNS/Domain/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/Zone/
- Notifications/
- Order/AddOn/
- Product/
- Server/
- Server/VirtualDomain/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Support/Alert/
- Utilities/Info/
- VIP/
- VPN/
API Documentation (API Version v1)
Network/Firewall/
DESCRIPTION
This section contains methods for manipulating the firewall of a storm server.
details
URL:
https://api.liquidweb.com/v1/Network/Firewall/details
Description:
Get details about the current firewall settings for a particular server. If no firewall is applied, a type of 'none' is returned. Otherwise, you get the various firewall types: 'basic', 'advanced', or 'saved', along with relevant details that apply to that firewall type. The system the firewall is setup under is also returned.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| allow | An array of a single word, consisting of only letters and digits. | |
| rules | An array of firewall rules. | * Required if:
|
| ruleset | A firewall ruleset name | * Required if:
|
| system | One of: 'liquidweb', 'nocworx_openstack' | |
| type | A valid firewall type (basic, saved, advanced, or none). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
getBasicOptions
URL:
https://api.liquidweb.com/v1/Network/Firewall/getBasicOptions
Description:
Returns a list of options that the basic firewall accepts.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| options | An array of a string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
rules
URL:
https://api.liquidweb.com/v1/Network/Firewall/rules
Description:
Returns the rules for the given server, regardless of type. The rules are returned under the rules field, which is an array reference.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| rules | An array of firewall rules. |
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/v1/Network/Firewall/update
Description:
Updates the firewall setting for a given server. The argument should mirror the data structures returned by details, with the addition of the uniq_id field.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| allow | An array of basic firewall options | * Required if:
|
| rules | An array of firewall rules. | * Required if:
|
| ruleset | A firewall ruleset name | * Required if:
|
| type | A valid firewall type (basic, saved, advanced, or none). | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| modified | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
