NSX-T Data Center REST API

List N-S Firewall Rules

List N-S Firewall Rules
GET /orgs/org1/projects/project1/vpcs/vpc-1/gateway-policies/default/rules

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules
Request Headers:
n/a
Query Parameters:
RuleListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default/rules

Successful Response:

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

Example Response:

{ "results": [ { "action": "ALLOW", "resource_type": "Rule", "id": "default-public-ip", "display_name": "ORG-default PROJECT-project-1 VPC-vpc-1 default-public-ip", "description": "default rule to allow outgoing traffic from the public subnets", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default/rules/default-public-ip", "relative_path": "default-public-ip", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default", "remote_path": "", "unique_id": "00000000-0000-0000-0000-000000001014", "realization_id": "00000000-0000-0000-0000-000000001014", "owner_id": "e1f5ef8a-21b7-48d1-9117-22797c2ea2dc", "origin_site_id": "e1f5ef8a-21b7-48d1-9117-22797c2ea2dc", "marked_for_delete": false, "overridden": false, "rule_id": 1014, "sequence_number": 2147483647, "sources_excluded": false, "destinations_excluded": false, "source_groups": [ "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default-public-ip-group" ], "destination_groups": [ "ANY" ], "services": [ "ANY" ], "profiles": [ "ANY" ], "logged": false, "disabled": false, "direction": "IN_OUT", "ip_protocol": "IPV4_IPV6", "is_default": true, "_create_time": 1668778432233, "_create_user": "system", "_last_modified_time": 1668778432233, "_last_modified_user": "system", "_system_owned": false, "_revision": 0 }, { "action": "DROP", "resource_type": "Rule", "id": "default", "display_name": "ORG-default PROJECT-project-1 VPC-vpc-1 default", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default/rules/default", "relative_path": "default", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/gateway-policies/default", "remote_path": "", "unique_id": "00000000-0000-0000-0000-000000001015", "realization_id": "00000000-0000-0000-0000-000000001015", "owner_id": "e1f5ef8a-21b7-48d1-9117-22797c2ea2dc", "origin_site_id": "e1f5ef8a-21b7-48d1-9117-22797c2ea2dc", "marked_for_delete": false, "overridden": false, "rule_id": 1015, "sequence_number": 2147483647, "sources_excluded": false, "destinations_excluded": false, "source_groups": [ "ANY" ], "destination_groups": [ "ANY" ], "services": [ "ANY" ], "profiles": [ "ANY" ], "logged": false, "disabled": false, "direction": "IN_OUT", "ip_protocol": "IPV4_IPV6", "is_default": true, "_create_time": 1668778432235, "_create_user": "system", "_last_modified_time": 1668778432235, "_last_modified_user": "system", "_system_owned": false, "_revision": 0 } ], "result_count": 2, "sort_by": "sequence_number", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_edge_fw

Additional Errors: