Skip to content
SYLVE

List Firewall NAT Rules

GET
/network/firewall/nat
curl --request GET \
  --url https://sylve.lan:8181/api/network/firewall/nat \
  --header 'Authorization: <Authorization>'

List all user-visible firewall NAT rules in evaluation order

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
Array<object>
object
createdAt
string
description
string
destObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value

IP, CIDR, port, country code, FQDN, etc.

string
id
integer
isUsed
boolean
isUsedBy
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp

Deprecated mirror for resolved IP entries

string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string
updatedAt
string
usedBy
Array<object>
object
id
integer
name
string
type
string
destObjId
integer
destRaw
string
dnatTargetObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value

IP, CIDR, port, country code, FQDN, etc.

string
id
integer
isUsed
boolean
isUsedBy
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp

Deprecated mirror for resolved IP entries

string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string
updatedAt
string
usedBy
Array<object>
object
id
integer
name
string
type
string
dnatTargetObjId
integer
dnatTargetRaw
string
dstPortObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value

IP, CIDR, port, country code, FQDN, etc.

string
id
integer
isUsed
boolean
isUsedBy
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp

Deprecated mirror for resolved IP entries

string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string
updatedAt
string
usedBy
Array<object>
object
id
integer
name
string
type
string
dstPortObjId
integer
dstPortsRaw
string
egressInterfaces

On style match

Array<string>
enabled
boolean
family

Any|inet|inet6

string
id
integer
ingressInterfaces

Received-on style match

Array<string>
log
boolean
name
string
natType

Snat|dnat|binat

string
passRedirectedTraffic
boolean
policyRouteGateway
string
policyRoutingEnabled
boolean
priority
integer
protocol
string
redirectPortObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value

IP, CIDR, port, country code, FQDN, etc.

string
id
integer
isUsed
boolean
isUsedBy
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp

Deprecated mirror for resolved IP entries

string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string
updatedAt
string
usedBy
Array<object>
object
id
integer
name
string
type
string
redirectPortObjId
integer
redirectPortsRaw
string
sourceObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value

IP, CIDR, port, country code, FQDN, etc.

string
id
integer
isUsed
boolean
isUsedBy
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp

Deprecated mirror for resolved IP entries

string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string
updatedAt
string
usedBy
Array<object>
object
id
integer
name
string
type
string
sourceObjId
integer
sourceRaw
string
targetAddressScope
string
targetHandling
string
translateMode

Interface|address

string
translateToObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value

IP, CIDR, port, country code, FQDN, etc.

string
id
integer
isUsed
boolean
isUsedBy
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp

Deprecated mirror for resolved IP entries

string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type

“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”

string
updatedAt
string
usedBy
Array<object>
object
id
integer
name
string
type
string
translateToObjId
integer
translateToRaw
string
updatedAt
string
visible
boolean
error
string
message
string
status
string
Examplegenerated
{
  "data": [
    {
      "createdAt": "example",
      "description": "example",
      "destObj": {
        "autoUpdate": true,
        "createdAt": "example",
        "description": "example",
        "entries": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "updatedAt": "example",
            "value": "example"
          }
        ],
        "id": 1,
        "isUsed": true,
        "isUsedBy": "example",
        "lastRefreshAt": "example",
        "lastRefreshError": "example",
        "name": "example",
        "refreshIntervalSeconds": 1,
        "resolutionChecksum": "example",
        "resolutions": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "resolvedIp": "example",
            "resolvedValue": "example",
            "updatedAt": "example"
          }
        ],
        "sourceChecksum": "example",
        "type": "example",
        "updatedAt": "example",
        "usedBy": [
          {
            "id": 1,
            "name": "example",
            "type": "example"
          }
        ]
      },
      "destObjId": 1,
      "destRaw": "example",
      "dnatTargetObj": {
        "autoUpdate": true,
        "createdAt": "example",
        "description": "example",
        "entries": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "updatedAt": "example",
            "value": "example"
          }
        ],
        "id": 1,
        "isUsed": true,
        "isUsedBy": "example",
        "lastRefreshAt": "example",
        "lastRefreshError": "example",
        "name": "example",
        "refreshIntervalSeconds": 1,
        "resolutionChecksum": "example",
        "resolutions": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "resolvedIp": "example",
            "resolvedValue": "example",
            "updatedAt": "example"
          }
        ],
        "sourceChecksum": "example",
        "type": "example",
        "updatedAt": "example",
        "usedBy": [
          {
            "id": 1,
            "name": "example",
            "type": "example"
          }
        ]
      },
      "dnatTargetObjId": 1,
      "dnatTargetRaw": "example",
      "dstPortObj": {
        "autoUpdate": true,
        "createdAt": "example",
        "description": "example",
        "entries": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "updatedAt": "example",
            "value": "example"
          }
        ],
        "id": 1,
        "isUsed": true,
        "isUsedBy": "example",
        "lastRefreshAt": "example",
        "lastRefreshError": "example",
        "name": "example",
        "refreshIntervalSeconds": 1,
        "resolutionChecksum": "example",
        "resolutions": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "resolvedIp": "example",
            "resolvedValue": "example",
            "updatedAt": "example"
          }
        ],
        "sourceChecksum": "example",
        "type": "example",
        "updatedAt": "example",
        "usedBy": [
          {
            "id": 1,
            "name": "example",
            "type": "example"
          }
        ]
      },
      "dstPortObjId": 1,
      "dstPortsRaw": "example",
      "egressInterfaces": [
        "example"
      ],
      "enabled": true,
      "family": "example",
      "id": 1,
      "ingressInterfaces": [
        "example"
      ],
      "log": true,
      "name": "example",
      "natType": "example",
      "passRedirectedTraffic": true,
      "policyRouteGateway": "example",
      "policyRoutingEnabled": true,
      "priority": 1,
      "protocol": "example",
      "redirectPortObj": {
        "autoUpdate": true,
        "createdAt": "example",
        "description": "example",
        "entries": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "updatedAt": "example",
            "value": "example"
          }
        ],
        "id": 1,
        "isUsed": true,
        "isUsedBy": "example",
        "lastRefreshAt": "example",
        "lastRefreshError": "example",
        "name": "example",
        "refreshIntervalSeconds": 1,
        "resolutionChecksum": "example",
        "resolutions": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "resolvedIp": "example",
            "resolvedValue": "example",
            "updatedAt": "example"
          }
        ],
        "sourceChecksum": "example",
        "type": "example",
        "updatedAt": "example",
        "usedBy": [
          {
            "id": 1,
            "name": "example",
            "type": "example"
          }
        ]
      },
      "redirectPortObjId": 1,
      "redirectPortsRaw": "example",
      "sourceObj": {
        "autoUpdate": true,
        "createdAt": "example",
        "description": "example",
        "entries": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "updatedAt": "example",
            "value": "example"
          }
        ],
        "id": 1,
        "isUsed": true,
        "isUsedBy": "example",
        "lastRefreshAt": "example",
        "lastRefreshError": "example",
        "name": "example",
        "refreshIntervalSeconds": 1,
        "resolutionChecksum": "example",
        "resolutions": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "resolvedIp": "example",
            "resolvedValue": "example",
            "updatedAt": "example"
          }
        ],
        "sourceChecksum": "example",
        "type": "example",
        "updatedAt": "example",
        "usedBy": [
          {
            "id": 1,
            "name": "example",
            "type": "example"
          }
        ]
      },
      "sourceObjId": 1,
      "sourceRaw": "example",
      "targetAddressScope": "example",
      "targetHandling": "example",
      "translateMode": "example",
      "translateToObj": {
        "autoUpdate": true,
        "createdAt": "example",
        "description": "example",
        "entries": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "updatedAt": "example",
            "value": "example"
          }
        ],
        "id": 1,
        "isUsed": true,
        "isUsedBy": "example",
        "lastRefreshAt": "example",
        "lastRefreshError": "example",
        "name": "example",
        "refreshIntervalSeconds": 1,
        "resolutionChecksum": "example",
        "resolutions": [
          {
            "createdAt": "example",
            "id": 1,
            "objectId": 1,
            "resolvedIp": "example",
            "resolvedValue": "example",
            "updatedAt": "example"
          }
        ],
        "sourceChecksum": "example",
        "type": "example",
        "updatedAt": "example",
        "usedBy": [
          {
            "id": 1,
            "name": "example",
            "type": "example"
          }
        ]
      },
      "translateToObjId": 1,
      "translateToRaw": "example",
      "updatedAt": "example",
      "visible": true
    }
  ],
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}