NSX-T Data Center REST API

Get rules filtered based on the given criteria

Get the list of rules of given parent path of policy/section, filtered
based on the given criteria.
Parent path is mandatory.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/global-infra/firewall/rules
/policy/api/v1/infra/firewall/rules

Request Headers:

n/a

Query Parameters:

FirewallFilterByRequestParameters+

FirewallFilterByRequestParameters (schema)

Name	Description	Type	Notes
enforcement_point_path	Path of the enforcement point Path of the enforcement point from where the result need to be fetched. If not provided, default enforcement point will be considered. It is mandatory parameter on global manager.	string
parent_path	Path of the parent object of the entities The path of the parent object of entities that are need to be filtered based in the given criteria. Parent path is required for filtering rules of particular policy.	string
scope	Scope filter criteria All those firewall entities, policies/rules, will be returned whose scope value satisfies the given criteria. The value for scope can be, - virtual machine id or - logical router id. Based on the given scope value, the entities will be filtered.	string	Required

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/firewall/rules?parent_path=/infra/domains/default/security-policies/sp1&scope=6f1c310b-aeed-445e-aef9-9722c8967ab8&enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyResourceReferenceForEPListResult+

PolicyResourceReferenceForEPListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of policy resource references for enforcement point	array of PolicyResourceReferenceForEP	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 2, "results": [ { { "path" : "/infra/domains/default/security-policies/sp1/rules/rule1", "target_id" : "rule1", "target_type" : "RULE", "is_valid" : "true" }, { "path" : "/infra/domains/default/security-policies/sp1/rules/rule2", "target_id" : "rule2", "target_type" : "RULE", "is_valid" : "true" } } ] }

Required Permissions:

read

Feature:

policy_dfw

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable