List Nat Rules

Returns paginated list of all user defined NAT rules of the specific logical router. If a rule_type is provided, only the given type of rules will be returned. If no rule_type is specified, the rule_type will be defaulted to NATv4, i.e. only the NATv4 rules will be listed.

This API has been deprecated, please use below Policy APIs
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules
GET /policy/api/v1/orgs/<org-id>/projects/<project-id>/infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-routers/{logical-router-id}/nat/rules

COPY

Path Parameters

string

logical-router-id

Required

logical-router-id

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

string

rule_type

Optional

Action type for getting NAT rules

Possible values are : ALL, NATv4, NAT64,

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns NatRuleListResult of type(s) application/json

This response body class contains all of the following: InlineNatRuleListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "action": "string",
            "applied_tos": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "enabled": false,
            "firewall_match": "string",
            "internal_rule_id": "string",
            "logging": false,
            "logical_router_id": "string",
            "match_destination_network": "string",
            "match_service": {
                "resource_type": "string"
            },
            "match_source_network": "string",
            "pb_vpn_mode": "string",
            "rule_priority": 0,
            "translated_network": "string",
            "translated_ports": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json