NSX-T Data Center REST API

Associated URIs:

API Description API Path

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

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/IPS intrusion detection rules in a policy


Returns a paginated list of all Intrusion Detection System (IDS) rules within a
specific intrusion service policy. Rules are evaluated in sequence to detect and
prevent network intrusion attempts based on configured IDS profiles.
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 a distributed IDS/IPS 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}

Read a distributed IDS/IPS intrusion detection rule by ID


Returns the configuration of a specific distributed IDS/IPS rule within an intrusion
service policy, identified by domain ID, policy ID, and rule ID.
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 a distributed IDS/IPS rule


Create or partially update a distributed IDS/IPS intrusion detection 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 a distributed IDS/IPS rule


Create or update a distributed IDS/IPS intrusion detection 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}
Additional Links