NSX-T Data Center REST API

Get All the Rules for a Section (Deprecated)

Return all firewall rule(s) information for a given firewall section.
Deprecated:
Use the following Policy API -
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>

Request:

Method:
GET
URI Path(s):
/api/v1/firewall/sections/<section-id>/rules
Request Headers:
n/a
Query Parameters:
FirewallListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/firewall/sections/16a93c39-5822-469e-b0be-70728153642e/rules?page_size=1

Successful Response:

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

Example Response:

{ "cursor": "003600000000-0000-0000-0000-0000000000022305843009213694015", "sort_by": "priority", "result_count": 2, "results": [ { "id": "111616", "display_name": "allow-icmp", "notes": "", "destinations_excluded": false, "destinations": [ { "target_display_name": "app-switch", "is_valid": true, "target_type": "LogicalSwitch", "target_id": "1d9fb5cb-0344-4d7f-899a-afd93276899f" }, { "target_display_name": "web-switch", "is_valid": true, "target_type": "LogicalSwitch", "target_id": "b489b427-9f14-401e-81db-d1105a1917fe" } ], "services": [ { "service": { "resource_type": "ICMPTypeNSService", "icmp_type": 8, "protocol": "ICMPv4", "icmp_code": 0 } } ], "ip_protocol": "IPV4_IPV6", "rule_tag": "", "logged": false, "action": "ALLOW", "sources_excluded": false, "disabled": false, "direction": "IN_OUT", "_revision": 3 }, { "id": "2", "display_name": "00000000-0000-0000-0000-000000000002", "notes": "", "destinations_excluded": false, "ip_protocol": "IPV4_IPV6", "rule_tag": "", "logged": false, "action": "ALLOW", "sources_excluded": false, "disabled": false, "direction": "IN_OUT", "_revision": 3 } ] }

Required Permissions:

read

Feature:

firewall_general

Additional Errors: