Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/Firewall/

DESCRIPTION

This section contains methods for manipulating the firewall of a storm server.

details

URL:

https://api.stormondemand.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.

Parameters:

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

Returns:

FieldTypeNotes
allowAn array of a single word, consisting of only letters and digits.
rulesAn array of firewall rules.* Required if:
  • type is set to 'advanced'
rulesetA firewall ruleset name* Required if:
  • type is set to 'saved'
typeA 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.stormondemand.com/v1/Network/Firewall/getBasicOptions

Description:

Returns a list of options that the basic firewall accepts.

Parameters:

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

Returns:

FieldType
optionsAn 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.stormondemand.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:

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

Returns:

FieldType
rulesAn array of firewall rules.
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

update

URL:

https://api.stormondemand.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:

ParameterTypeNotes
allowAn array of basic firewall options* Required if:
  • type is set to 'basic'
rulesAn array of firewall rules.* Required if:
  • type is set to 'advanced'
rulesetA firewall ruleset name* Required if:
  • type is set to 'saved'
typeA valid firewall type (basic, saved, advanced, or none).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
modifiedA six-character identifier, containing only capital letters and digits.

Possible Errors:

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