NSX-T Data Center REST API

Associated URIs:

API Description API Path

List IDS gateway policies


List all IDS gateway policies for specified Domain.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies

Delete IDS GatewayPolicy


Delete IDS GatewayPolicy
DELETE /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}

Read IDS gateway policy


Read IDS gateway policy for a domain.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}

Update IDS gateway policy


Update the IDS gateway policy for a domain.
PATCH /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}

Revise the positioning of IDS gateway policy


This is used to set a precedence of a IDS gateway policy w.r.t others.
POST /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}?action=revise

Update IDS gateway policy


Update the IDS gateway policy for a domain.
PUT /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}

List IDS Gateway rules


List IDS Gateway rules
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules

Delete IDS Gateway rule


Delete IDS Gateway rule
DELETE /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}

Read IDS rule


Read IDS rule
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}

Update IDS gateway rule


Update the gateway rule.
PATCH /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}

Revise the positioning of IDS gateway rule


This is used to re-order a IDS gateway rule within a IDS gateway policy.
POST /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}?action=revise

Create or Update IDS gateway rule


Create or Update the IDS gateway rule.
PUT /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}

Get IDS gateway rule statistics


Get statistics of a IDS gateway rule.
- no enforcement point path specified: Stats will be evaluated on each enforcement.
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-gateway-policies/{policy-id}/rules/{rule-id}/statistics

List IDS security policies


List intrusion detection system security policies.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies

Get IDS-IPS rule statistics


Get statistics of a IDS-IPS rule.
- no enforcement point path specified: Stats will be evaluated on each enforcement
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{ids-policy-id}/rules/{rule-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{ids-policy-id}/rules/{rule-id}/statistics

Delete IDS security policy


Delete intrusion detection system security policy.
DELETE /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}

Get IDS security policy.


Read intrusion detection system security policy.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}

Patch IDS security policy


Patch intrusion detection system security policy for a domain.
PATCH /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}

Revise the positioning of IDS security policies


This is used to set a precedence of a security policy w.r.t others.
POST /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}?action=revise
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}?action=revise

create or update IDS security policy


Update intrusion detection system security policy for a domain.
PUT /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}

List IDS rules


List intrusion detection rules.
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules

Delete IDS rule


Delete intrusion detection rule.
DELETE /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}

Get IDS rule.


Read intrusion detection rule
GET /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}

Patch IDS rule


Patch intrusion detection system rule.
PATCH /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}

Revise the positioning of IDS rule


This is used to re-order a rule within a security policy.
POST /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}?action=revise
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}?action=revise

create or update IDS rule


Update intrusion detection system rule.
PUT /policy/api/v1/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/intrusion-service-policies/{policy-id}/rules/{rule-id}

Reset IDS-IPS rule statistics


Sets IDS-IPS rule statistics counter to zero.
- no enforcement point path specified: Reset of stats will be executed for
each enforcement point.
- {enforcement_point_path}: Reset of stats will be executed only for the given
enforcement point.
POST /policy/api/v1/infra/settings/firewall/security/intrusion-services/stats?action=reset
Additional Links