Get Firewall Rules
Retrieves all user-defined and default firewall rules for a given edge gateway. The rules are returned in the order of precedence.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/firewall/rules
COPY
Path Parameters
string
externalNetworkId
Required
externalNetworkId
string
externalNetworkId
Required
externalNetworkId
Responses
200
OK
Returns GatewayFirewallRules of type(s) application/json;version=39.0
This response body class contains all of the following: NetworkingEntityStatus , InlineGatewayFirewallRules1
{
"status": "string",
"systemRules": [
{
"id": "string",
"name": "string",
"description": "string",
"sourceFirewallGroups": [
{
"name": "string",
"id": "string"
}
],
"sourceFirewallIpAddresses": [
"string"
],
"destinationFirewallGroups": [
{
"name": "string",
"id": "string"
}
],
"destinationFirewallIpAddresses": [
"string"
],
"applicationPortProfiles": [
{
"name": "string",
"id": "string"
}
],
"rawPortProtocols": [
{
"layer4Item": {
"protocol": "string",
"sourcePorts": [
"8080",
"8090-8095"
],
"destinationPorts": [
"20",
"21",
"139-445"
]
}
}
],
"ipProtocol": "string",
"actionValue": "string",
"direction": "string",
"logging": false,
"networkContextProfiles": [
{
"name": "string",
"id": "string"
}
],
"active": false,
"version": {
"version": 0
},
"comments": "string",
"appliedTo": {
"name": "string",
"id": "string"
},
"loggingId": "string",
"relativePosition": {
"adjacentRuleId": "string",
"rulePosition": "string"
}
}
],
"userDefinedRules": [
{
"id": "string",
"name": "string",
"description": "string",
"sourceFirewallGroups": [
{
"name": "string",
"id": "string"
}
],
"sourceFirewallIpAddresses": [
"string"
],
"destinationFirewallGroups": [
{
"name": "string",
"id": "string"
}
],
"destinationFirewallIpAddresses": [
"string"
],
"applicationPortProfiles": [
{
"name": "string",
"id": "string"
}
],
"rawPortProtocols": [
{
"layer4Item": {
"protocol": "string",
"sourcePorts": [
"8080",
"8090-8095"
],
"destinationPorts": [
"20",
"21",
"139-445"
]
}
}
],
"ipProtocol": "string",
"actionValue": "string",
"direction": "string",
"logging": false,
"networkContextProfiles": [
{
"name": "string",
"id": "string"
}
],
"active": false,
"version": {
"version": 0
},
"comments": "string",
"appliedTo": {
"name": "string",
"id": "string"
},
"loggingId": "string",
"relativePosition": {
"adjacentRuleId": "string",
"rulePosition": "string"
}
}
],
"defaultRules": [
{
"id": "string",
"name": "string",
"description": "string",
"sourceFirewallGroups": [
{
"name": "string",
"id": "string"
}
],
"sourceFirewallIpAddresses": [
"string"
],
"destinationFirewallGroups": [
{
"name": "string",
"id": "string"
}
],
"destinationFirewallIpAddresses": [
"string"
],
"applicationPortProfiles": [
{
"name": "string",
"id": "string"
}
],
"rawPortProtocols": [
{
"layer4Item": {
"protocol": "string",
"sourcePorts": [
"8080",
"8090-8095"
],
"destinationPorts": [
"20",
"21",
"139-445"
]
}
}
],
"ipProtocol": "string",
"actionValue": "string",
"direction": "string",
"logging": false,
"networkContextProfiles": [
{
"name": "string",
"id": "string"
}
],
"active": false,
"version": {
"version": 0
},
"comments": "string",
"appliedTo": {
"name": "string",
"id": "string"
},
"loggingId": "string",
"relativePosition": {
"adjacentRuleId": "string",
"rulePosition": "string"
}
}
]
}
404
The specified resource was not found
Returns Error of type(s) application/json;version=39.0
{
"minorErrorCode": "string",
"message": "string",
"stackTrace": "string"
}string
minorErrorCode
Required
minorErrorCode
string
message
Required
message
string
stackTrace
Optional
stackTrace
Availability
Added in 33.0
Deprecated in 38.1
With alternative: see
See /cloudapi/2.0.0/edgeGateways/{gatewayId}/firewall/rules. New Model is GatewayFirewallRules.
Edge Gateway Firewall Rules Operations
POST
Create Firewall Rule
DELETE
Delete Firewall Rules
GET
Get Firewall Rules
PUT
Update Firewall Rules