NSX-T Data Center REST API

Associated URIs:

API Description API Path

List of VPC gateway policies


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

Delete Gateway Policy


Delete Gateway Policy.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}

Get Gateway Policy


Get Gateway Policy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}

Create or update Gateway Policy


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

Revise the positioning of VPC gateway policies


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

Update the Gateway Policy


Update the Gateway Policy.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}

List N-S Firewall Rules


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

Delete N-S Firewall Rule


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

Read N-S Firewall Rule


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

Patch N-S Firewall Rule


Patch the N-S 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/gateway-policies/default/rules/rule-1
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}

Revise the positioning of VPC N-S Firewall rule


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

Create or update N-S Firewall Rule


Update the N-S 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/gateway-policies/default/rules/rule-1
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}

Get rule statistics


Get statistics of N-S 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}/gateway-policies/{gateway-policy-id}/rules/{rule-id}/statistics

Get gateway policy statistics


Get statistics of a gateway 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}/gateway-policies/{gateway-policy-id}/statistics