Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/Firewall/Ruleset/

DESCRIPTION

You can save your current firewall settings into a ruleset, which you can then apply to other servers, allowing you to give predefined roles to various servers.

This section of the API gives you access to saving and querying your saved rulesets.

create

URL:

https://api.stormondemand.com/v1/Network/Firewall/Ruleset/create

Description:

Saves the ruleset that the given server is using under the given name. The server will be set to a firewall type of 'saved', with this ruleset as its ruleset.

Parameters:

ParameterTypeNotes
nameA firewall ruleset name* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
destination_ipsAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
rulesAn array of firewall rules.
rulesetA firewall ruleset name
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.stormondemand.com/v1/Network/Firewall/Ruleset/details

Description:

Returns the rules and valid destinations ips for the given ruleset.

Parameters:

ParameterTypeNotes
rulesetA firewall ruleset name* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
destination_ipsAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
rulesAn array of firewall rules.
rulesetA firewall ruleset name
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.stormondemand.com/v1/Network/Firewall/Ruleset/list

Description:

Returns an array reference of rulesets that have been saved for use by this account.

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accntA valid account number, up to 6 digits in length.
destination_ipsAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
rulesAn array of firewall rules.
rulesetA firewall ruleset name
uniq_idA six-character identifier, containing only capital letters and digits.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.stormondemand.com/v1/Network/Firewall/Ruleset/update

Description:

Updates the saved ruleset with the given ruleset. Returns a list of affected servers.

Parameters:

ParameterTypeNotes
rulesAn array of firewall rules.* Required
rulesetA firewall ruleset name* Required

Returns:

FieldType
updatedAn array of a six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types