Get Nat Rules

Get Nat Rules

Retrieves all NAT Rules on the edge gateway. Pagination is supported to get the next page in the header response. Results can be sorted by only a single parameter. Sorting by combination of parameters (sortAsc=foo&sortDesc=bar) is not allowed. By default, if no sort parameter is set, the NAT rules are sorted by the priority, starting with the lowest value (highest priority).

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/nat/rules
COPY
Path Parameters
string
externalNetworkId
Required

externalNetworkId

string
externalNetworkId
Required

externalNetworkId

Query Parameters
string
cursor
Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.

integer
pageSize
Required

Results per page to fetch.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GatewayNatRules of type(s) application/json;version=39.0
This response body class contains all of the following: NetworkingObjectStatus , InlineGatewayNatRules1 
{
    "status": {},
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "enabled": false,
            "active": false,
            "type": "string",
            "applicationPortProfile": {
                "name": "string",
                "id": "string"
            },
            "externalAddresses": "string",
            "internalAddresses": "string",
            "dnatExternalPort": "string",
            "logging": false,
            "systemRule": false,
            "snatDestinationAddresses": "string",
            "firewallMatch": "string",
            "priority": 0,
            "version": {
                "version": 0
            },
            "appliedTo": {
                "name": "string",
                "id": "string"
            },
            "policyBasedVpnMode": "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.0
With alternative: see
See /cloudapi/2.0.0/edgeGateways/{gatewayId}/nat/rules.
On This Page
Edge Gateway Nat Rules Operations
POST
Create Nat Rule
GET
Get Nat Rules