NSX-T Data Center REST API

Associated URIs:

API Description API Path

List of VPC security policies


Paginated list of VPC security policies.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies

Delete SecurityPolicy


Delete SecurityPolicy.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}

Get SecurityPolicy


Get SecurityPolicy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}

Create or update SecurityPolicy


If a SecurityPolicy with the policy-id is not already present,
create a new SecurityPolicy. If it already exists, update the SecurityPolicy.
This is a full replace.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}

Revise the positioning of VPC security policies


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

Update the SecurityPolicy


Update the SecurityPolicy.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}

List E-W Firewall Rules


List Rules
GET /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules

Delete E-W Firewall Rule


Delete E-W Firewall Rule
DELETE /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}

Read E-W Firewall Rule


Read Rule
GET /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}

Patch E-W Firewall Rule


Patch the E-W Firewall Rule. If a Rule for the given
Rule-id is not present, the object will get created and if
it is present it will be updated. This is a full replace
PATCH /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}

Revise the positioning of VPC E-W Firewall rule


This is used to re-order a rule within a VPC security policy.
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}?action=revise

Create or update E-W Firewall Rule


Update the E-W Firewall Rule. If a Rule with the rule-id
is not already present, this API fails with a 404. Creation of Rules
is not allowed using this API.
PUT /orgs/org1/projects/project1/vpcs/vpc-1/security-policies/default/rules/rule-1
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}

Get rule statistics


Get statistics of E-W Firewall 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/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/rules/{rule-id}/statistics

Get security policy statistics


Get statistics of a security policy.
- 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/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/{security-policy-id}/statistics