NSX-T Data Center REST API

List IDS rules

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

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules
Request Headers:
n/a
Query Parameters:
IdsRuleListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/domains/default/intrusion-service-policies/sp1/rules

Successful Response:

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

Example Response:

{ "results": [ { "action": "DETECT", "ids_profiles": [ "/infra/settings/firewall/security/intrusion-services/profiles/DefaultIDSProfile" ], "resource_type": "IdsRule", "id": "rule1", "display_name": "Test-Rule", "path": "/infra/domains/default/intrusion-service-policies/sp1/rules/rule1", "relative_path": "rule1", "parent_path": "/infra/domains/default/intrusion-service-policies/sp1", "unique_id": "a22f5517-bdbf-45e7-a621-5fd50867eeea", "marked_for_delete": false, "sequence_number": 100, "sources_excluded": false, "destinations_excluded": false, "source_groups": [ "/infra/domains/default/groups/Empty_Group" ], "destination_groups": [ "/infra/domains/default/groups/Empty_Group" ], "logged": true, "scope": [ "/infra/domains/default/groups/Empty_Group" ], "disabled": true, "direction": "OUT", "_create_user": "admin", "_create_time": 1563265736078, "_last_modified_user": "admin", "_last_modified_time": 1563265736082, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 4 } ], "result_count": 1, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_dfw_ids_mps

Additional Errors: