NSX-T Data Center REST API

List NAT Rules

List NAT Rules under the given Transit Gateway, under the given NAT section.
This API is only available when using VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}/nat-rules
Request Headers:
n/a
Query Parameters:
TransitGatewayNatRuleListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER/nat-rules

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TransitGatewayNatRuleListResult+

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 3, "results": [ { "resource_type": "TransitGatewayNatRule", "description": "Example of a NAT rule", "id": "MyNATRule", "display_name": "MyNATRule", "path": "/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER/nat-rules/MyNATRule", "parent_path": "/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER", "relative_path": "MyNATRule", "sequence_number": 1, "action": "REFLEXIVE", "enabled" : true, "logging" : false, "firewall_match" : "MATCH_EXTERNAL_ADDRESS", "source_network": "10.117.5.73", "translated_network": "192.168.1.1", "_create_user": "admin", "_create_time": 1516015559976, "_last_modified_user": "admin", "_last_modified_time": 1516015559976, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "resource_type": "TransitGatewayNatRule", "description": "Example of a NAT rule", "id": "MyNATRule3", "display_name": "MyNATRule3", "path": "/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER/nat-rules/MyNATRule3", "parent_path": "/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER", "relative_path": "MyNATRule3", "sequence_number": 10, "action": "DNAT", "enabled" : true, "logging" : false, "firewall_match" : "MATCH_EXTERNAL_ADDRESS", "destination_network": "10.117.5.19", "translated_network": "192.168.1.1", "_create_user": "admin", "_create_time": 1516084472276, "_last_modified_user": "admin", "_last_modified_time": 1516084472276, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "resource_type": "TransitGatewayNatRule", "description": "Example of a NAT rule", "id": "MyNATRuleDemo", "display_name": "MyNATRuleDemo", "path": "/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER/nat-rules/MyNATRuleDemo", "parent_path": "/orgs/org1/projects/project1/transit-gateways/tgw1/nat/USER", "relative_path": "MyNATRuleDemo", "sequence_number": 10, "action": "DNAT", "enabled" : true, "logging" : false, "firewall_match" : "MATCH_EXTERNAL_ADDRESS", "destination_network": "10.117.5.19", "translated_network": "192.168.1.1", "_create_user": "admin", "_create_time": 1516181809835, "_last_modified_user": "admin", "_last_modified_time": 1516181809835, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }] }

Required Permissions:

read

Feature:

policy_nat_rules

Additional Errors: