UpCloud SDN Firewall API. Allows creation, management and deletion of Firewall rulesets and Firewall rules.
List firewall rulesets
Returns a list of firewall rulesets.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
Order of returned results.
Schema for a query parameter specifying the sort field.
List firewall rulesets › Responses
OK
Response schema for a list of firewall rulesets.
uuidThe unique identifier for the server.
name^[a-zA-Z0-9_-]+$Name of the firewall ruleset
descriptionDescription of the firewall ruleset
statefulversionThe firewall ruleset version.
enableddefault_dns_rules_enabledLabels
server_uuidThe unique identifier for the server.
created_atupdated_atCreate firewall ruleset
Creates a new firewall rulesets.
Create firewall ruleset › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the firewall ruleset
uuidThe unique identifier for the resource.
descriptionDescription of the firewall ruleset
statefulenableddefault_dns_rules_enabledLabels
server_uuidThe unique identifier for the resource.
Create firewall ruleset › Responses
Created
uuidThe unique identifier for the server.
name^[a-zA-Z0-9_-]+$Name of the firewall ruleset
descriptionDescription of the firewall ruleset
statefulversionThe firewall ruleset version.
enableddefault_dns_rules_enabledLabels
server_uuidThe unique identifier for the server.
created_atupdated_atGet firewall ruleset details
Returns firewall ruleset details by given {ruleset-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
Get firewall ruleset details › Responses
OK
uuidThe unique identifier for the server.
name^[a-zA-Z0-9_-]+$Name of the firewall ruleset
descriptionDescription of the firewall ruleset
statefulversionThe firewall ruleset version.
enableddefault_dns_rules_enabledLabels
server_uuidThe unique identifier for the server.
created_atupdated_atDelete firewall ruleset
Deletes existing firewall ruleset by given {ruleset-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
Delete firewall ruleset › Responses
No Content
Modify firewall ruleset
Modifies existing firewall ruleset by given {ruleset-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
Modify firewall ruleset › Request Body
name^[a-zA-Z0-9_-]+$Name of the ruleset
descriptionDescription of the firewall ruleset
Labels
enabledEnabled
default_dns_rules_enabledModify firewall ruleset › Responses
OK
uuidThe unique identifier for the server.
name^[a-zA-Z0-9_-]+$Name of the firewall ruleset
descriptionDescription of the firewall ruleset
statefulversionThe firewall ruleset version.
enableddefault_dns_rules_enabledLabels
server_uuidThe unique identifier for the server.
created_atupdated_atRestore firewall ruleset
Restores existing firewall ruleset by given {ruleset-uuid} and {ruleset-version}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
ruleset-versionFirewall ruleset version
The firewall ruleset version.
Restore firewall ruleset › Responses
OK
uuidThe unique identifier for the server.
name^[a-zA-Z0-9_-]+$Name of the firewall ruleset
descriptionDescription of the firewall ruleset
statefulversionThe firewall ruleset version.
enableddefault_dns_rules_enabledLabels
server_uuidThe unique identifier for the server.
created_atupdated_atList firewall ruleset rules
Returns firewall ruleset rules.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
Order of returned results.
Schema for a query parameter specifying the sort field.
List firewall ruleset rules › Responses
OK
Response schema for a list of firewall ruleset rules.
actiondirectionfamilyuuidThe unique identifier for the server.
enabledEnabled
commentComments
destination_address_startdestination_address_enddestination_port_startdestination_port_enddestination_address_cidricmp_typepositionprotocolsource_address_startsource_address_endsource_port_startsource_port_endsource_address_cidrCreate firewall ruleset rule
Creates a new firewall ruleset rule by the given {ruleset-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
Create firewall ruleset rule › Request Body
actiondirectionfamilyuuidThe unique identifier for the resource.
enabledEnabled
commentComments
destination_address_startdestination_address_enddestination_port_startdestination_port_enddestination_address_cidricmp_typepositionprotocolsource_address_startsource_address_endsource_port_startsource_port_endsource_address_cidrCreate firewall ruleset rule › Responses
Created
actiondirectionfamilyuuidThe unique identifier for the server.
enabledEnabled
commentComments
destination_address_startdestination_address_enddestination_port_startdestination_port_enddestination_address_cidricmp_typepositionprotocolsource_address_startsource_address_endsource_port_startsource_port_endsource_address_cidrGet firewall ruleset rule details
Returns firewall ruleset rule details.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
rule-idFirewall ruleset rule UUID
The unique identifier for the server.
Get firewall ruleset rule details › Responses
OK
actiondirectionfamilyuuidThe unique identifier for the server.
enabledEnabled
commentComments
destination_address_startdestination_address_enddestination_port_startdestination_port_enddestination_address_cidricmp_typepositionprotocolsource_address_startsource_address_endsource_port_startsource_port_endsource_address_cidrDelete firewall ruleset rule
Deletes an existing rule by given {ruleset-uuid} and {rule-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
rule-idFirewall ruleset rule UUID
The unique identifier for the server.
Delete firewall ruleset rule › Responses
No Content
Modify firewall ruleset rule
Modifies existing firewall ruleset rule by given {ruleset_uuid} and {rule-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
rule-idFirewall ruleset rule UUID
The unique identifier for the server.
Modify firewall ruleset rule › Request Body
enabledEnabled
actioncommentComments
destination_address_startdestination_address_enddestination_port_startdestination_port_enddestination_address_cidrdirectionfamilyicmp_typepositionprotocolsource_address_startsource_address_endsource_port_startsource_port_endsource_address_cidrModify firewall ruleset rule › Responses
OK
actiondirectionfamilyuuidThe unique identifier for the server.
enabledEnabled
commentComments
destination_address_startdestination_address_enddestination_port_startdestination_port_enddestination_address_cidricmp_typepositionprotocolsource_address_startsource_address_endsource_port_startsource_port_endsource_address_cidrList firewall ruleset labels
Returns a list of available firewall ruleset labels by given {ruleset-uuid}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
List firewall ruleset labels › Responses
OK
Response schema for listing labels.
keyvalueCreate firewall ruleset label
Creates a new label by given {ruleset-uuid}. Labels are used for group filtering.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
Create firewall ruleset label › Request Body
key^[\x20-\x5E\x60-\x7E… · requiredKey
value\A[\p{L}\p{N}\p{P}\p… · requiredValue
Create firewall ruleset label › Responses
Created
keyvalueGet firewall ruleset label details
Returns label details by given {ruleset-uuid} and {label-key}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
label-key^[\x20-\x5E\x60-\x7E… · requiredThe key of the label.
The key of a label.
Get firewall ruleset label details › Responses
OK
keyvalueDelete firewall ruleset label
Deletes existing label by given {ruleset-uuid} and {label-key}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
label-key^[\x20-\x5E\x60-\x7E… · requiredThe key of the label.
The key of a label.
Delete firewall ruleset label › Responses
No Content
Modify firewall ruleset label
Modifies existing label by given {ruleset-uuid} and {label-key}.
path Parameters
ruleset-uuidFirewall ruleset UUID
The unique identifier for the server.
label-key^[\x20-\x5E\x60-\x7E… · requiredThe key of the label.
The key of a label.
Modify firewall ruleset label › Request Body
key^[\x20-\x5E\x60-\x7E…The key of a label.
value\A[\p{L}\p{N}\p{P}\p…Schema for a label value property, allowing a string or null with specific character constraints.
Modify firewall ruleset label › Responses
OK
keyvalueList server firewall rules
Returns a list of server firewall rules.
path Parameters
server-uuidServer UUID
The unique identifier for the server.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
Order of returned results.
Schema for a query parameter specifying the sort field.
List server firewall rules › Responses
OK
Server firewall rules.
Create multiple server firewall rules
Creates multiple server firewall rules by given {server-uuid}.
path Parameters
server-uuidServer UUID
The unique identifier for the server.
Create multiple server firewall rules › Responses
OK
Server firewall rules.
Create server firewall rule
Creates a new server firewall rule.
path Parameters
server-uuidServer UUID
The unique identifier for the server.
Create server firewall rule › Request Body
Server firewall rule
Create server firewall rule › Responses
Created
Server firewall rule
Get server firewall rule details
Returns server firewall rule details by given {server-uuid} and {position}.
path Parameters
server-uuidServer UUID
The unique identifier for the server.
position^([1-9][0-9]?[0-9]?|… · requiredServer firewall rule position
The server firewall rule position.
Get server firewall rule details › Responses
OK
Server firewall rule
Delete server firewall rule
Deletes existing server firewall rule by given {server-uuid} and {position}.
path Parameters
server-uuidServer UUID
The unique identifier for the server.
position^([1-9][0-9]?[0-9]?|… · requiredServer firewall rule position
The server firewall rule position.
Delete server firewall rule › Responses
No Content
List server firewall rules
Admin List server firewall rules.
path Parameters
server-uuidServer UUID
The unique identifier for the server.
List server firewall rules › Request Body
Server firewall rule
List server firewall rules › Responses
OK
Server firewall rules.