NSX-T Data Center REST API

List E-W Firewall Rules

List Rules
GET /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules

Request:

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

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules

Successful Response:

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

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [{ "resource_type": "Rule", "description": "VPC Policy Rule1", "id": "rule-1", "display_name": "rule-1", "path": "/orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1", "parent_path": "/orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default", "relative_path": "rule-1", "sequence_number": 1, "source": [ "/orgs/org1/projects/project1/vpcs/vpc-1/groups/group1" ], "destination": [ "/orgs/org1/projects/project1/vpcs/vpc-1/groups/group2" ], "services": [ "ANY" ], "action": "ALLOW", "logged": true, "disabled": false, "notes": "This is sample Policy Rule to allow HTTPS traffic between default and prod-policy", "_create_user": "admin", "_create_time": 1517317382942, "_last_modified_user": "admin", "_last_modified_time": 1517317382962, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }] }

Required Permissions:

read

Feature:

policy_dfw

Additional Errors: