NSX-T Data Center REST API

List rules

List rules

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules
/policy/api/v1/global-infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-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/infra/domains/vmc-domain/gateway-policies/default/rules/entry1

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": "entry1", "id": "entry1", "display_name": "entry1", "path": "/infra/domains/vmc-domain/gateway-policies/default/rules/entry1", "parent_path": "/infra/domains/vmc-domain/gateway-policies/default", "relative_path": "entry1", "sequence_number": 0, "source_groups": [ "/infra/tier-0s/vmc/groups/source" ], "logged": false, "destination_groups": [ "/infra/domains/vmc-domain/groups/destination" ], "scope": [ "/infra/tier-0s/vmc" ], "action": "ALLOW", "services": [ "/infra/services/HTTP" ], "_create_user": "admin", "_create_time": 1516386404233, "_last_modified_user": "admin", "_last_modified_time": 1516431370604, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 3 } ] }

Required Permissions:

read

Feature:

policy_edge_fw

Additional Errors: