NSX-T Data Center REST API

List rules

List rules This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules
/policy/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules
Request Headers:
n/a
Query Parameters:
ForwardingRuleListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/forwarding-policy-1 /rules

Successful Response:

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

Example Response:

{ { "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "resource_type": "ForwardingRule", "description": "s3 rule", "id": "rule-1", "display_name": "rule-1", "action":"FORWARD_TO_UNDERLAY", "tags": [], "path": "/infra/domains/domain1/forwarding-policies/forwarding-policy-1000/rules/forwarding-rule-1", "relative_path": "rule-1", "sequence_number": 0, "source_groups": [ "/infra/domains/domain1/groups/srcgrp" ], "services": [ "ANY" ], "logged": false, "destination_groups": [ "/infra/domains/default/groups/S3" ], "_create_user": "admin", "_create_time": 1509362026134, "_last_modified_user": "admin", "_last_modified_time": 1509362026135, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1, "scope" : [ "ANY" ] }] }

Required Permissions:

read

Feature:

policy_forwarding

Additional Errors: