NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get LB node capacity


API is used to retrieve available load balancer capacity status for all
service clusters shared with Project.
Currently Edge cluster is supported as service cluster.
If the parameter ?service_cluster_path=<service-cluster-path> exists,
then API only shows the available load balancer capacity status for this
specific service cluster.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/lb-node-capacity-status

List VPC Connectivity Profiles


List VPC Connectivity Profiles.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-connectivity-profiles

Delete VPC Connectivity Profile


Deletes the specified VPC Connectivity Profile.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-connectivity-profiles/{vpc-connectivity-profile-id}

Get the VPC Connectivity Profile


Get the VPC Connectivity Profile 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-connectivity-profiles/{vpc-connectivity-profile-id}

Patch VPC Connectivity Profile


Create VPC Connectivity Profile if not already present,
otherwise update the VPC Connectivity Profile.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-connectivity-profiles/{vpc-connectivity-profile-id}

Create Or Replace VPC Connectivity Profile


If the VPC Connectivity Profile is not already present,
create a VPC Connectivity Profile instance. If it already exists, replace
the VPC Connectivity Profile instance with this object.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-connectivity-profiles/{vpc-connectivity-profile-id}

List of VpcSecurityProfiles


Paginated list of VpcSecurityProfiles.
Note: Currently this API will return only a single default security profile at the project level.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-security-profiles

Get VpcSecurityProfile


Get security profile with the specified ID.
Currently only the default security profile at the project level can be queried using this API.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-security-profiles/{vpc-security-profile-id}

Update Security Profile


Update existing default security profile.
Note: Currently, user will not be able to create new security profiles.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-security-profiles/{vpc-security-profile-id}

Update Security Profile


Update existing security profile.
Note: Currently, user will not be able to create new security profiles.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-security-profiles/{vpc-security-profile-id}

List VPC Service Profiles


List VPC Service Profiles.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-service-profiles

Delete VPC Service Profile


Deletes the specified VPC Service Profile.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-service-profiles/{vpc-service-profile-id}

Get the VPC Service Profile


Get the VPC Service Profile 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-service-profiles/{vpc-service-profile-id}

Patch VPC Service Profile


Create VPC Service Profile if not already present,
otherwise update the VPC Service Profile.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-service-profiles/{vpc-service-profile-id}

Create Or Replace VPC Service Profile


If the VPC Service Profile is not already present,
create a VPC Service Profile instance. If it already exists, replace
the VPC Service Profile instance with this object.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpc-service-profiles/{vpc-service-profile-id}

List of VPC


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

Delete VPC and its children


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

Get VPC


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

Create or update VPC


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

Update the VPC


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

List networks advertised to the VPC


Return networks which are advertised to connected VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/advertised-networks

List networks advertised to the VPC in CSV format


Return networks which are advertised to connected VPC in CSV format.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/advertised-networks/download

Get VPC Address Resolution Protocol proxies


Returns ARP proxy table for a VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/arp-proxies

Get VPC Address Resolution Protocol proxies in CSV format


Returns ARP proxy table for a VPC in CSV format.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/arp-proxies/download

List of VPC Attachment


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

Delete VPC Attachment


Delete VPC Attachment
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}

Get VPC Attachment


Get VPC Attachment
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}

Update VPC Attachment


Each VPC has one attachment. This API will update the VPC attachment.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}

Update the VPC attachment


Update the VPC attachment.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}

Get DNS Forwarder statistics


Get the DNS Forwarder statistics.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/dns-forwarder-statistics

Get forwarding table from VPC


Get forwarding table from VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/forwarding-table

Get forwarding table from VPC in CSV format


Get forwarding table from VPC in CSV format.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/forwarding-table/download

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

Get groups for which the given object is a member


Get policy groups for which the given object is a member.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/group-associations

List VPC Groups


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

Delete VPC Group


Delete VPC Group.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}

Get VPC Group


Get VPC Group
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}

Create or update VPC Group


If a VPC group with the group-id is not already present, create a new VPC group.
If it already exists, update the group.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}

Create or update VPC Group


If a VPC group with the group-id is not already present, create a new VPC group.
If it already exists, update the VPC group.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}

Get member types for a given VPC Group


It retrieves member types for a given VPC group. In case of nested VPC groups, it calculates
member types of child groups as well. Considers member type for members added
via static members and dynamic membership criteria.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/member-types

Get IP addresses that belong to this VPC Group


Get IP addresses that belong to this VPC Group.
This API is applicable for Groups containing either VirtualMachine, VIF,
Segment ,Segment Port or IP Address member type.For Groups containing other
member types,an empty list is returned
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/ip-addresses

Get subnet ports that belong to this VPC Group


Get subnet ports that belong to this VPC Group
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/subnet-ports

Get subnets that belong to this VPC Group


Get subnets that belong to this VPC Group
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/subnets

Get Virtual Network Interface instances that belong to this Group


Get Virtual Network Interface instances that belong to this Group.
This API is applicable for Groups containing VirtualNetworkInterface and VirtualMachine member types.
For Groups containing other member types,an empty list is returned. target_id in response
is external_id of VirtualNetworkInterface or VirtualMachine.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/vifs

Get Virtual machines that belong to this VPC Group


Get Virtual machines that belong to this VPC Group.
This API is applicable for Groups containing VirtualMachine,member type.
For Groups containing other member types,an empty list is returned.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups/{group-id}/members/virtual-machines

List VPC ip allocations


List all the ip allocations for a VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations

Records intent to release an IP from an IpPool.


Releases the IP that was allocated for this allocation request
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}

Get VPC ip allocation by ID


Get detail information on VPC ip allocation by giving ID.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}

Patch a VPC ip allocation


Create a VPC ip allocation if it does not exist
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}

Create or update a VPC ip allocation


Create a VPC ip allocation if it does not exist
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-allocations/{ip-address-allocation-id}

Get groups for which the given IP address is a member


Get policy groups for which the given IP address is a member.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/ip-address-group-associations

List Policy NAT types.


List the two supported sections (USER and NAT64) under the given VPC ID.
The USER section allows IPV4 based NAT rules, while the NAT64 rules allow
translating IPV6 packets to IPV4 packets.
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat

GET Policy NAT types.


Get either of the two supported sections (USER and NAT64) under the given VPC ID.
The USER section allows IPV4 based NAT rules, while the NAT64 rules allow
translating IPV6 packets to IPV4 packets.
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}

List NAT Rules


List NAT Rules from VPC denoted by VPC ID, under NAT section
denoted by <nat-id>.
Under VPC there will be 2 different NATs(sections).
(USER and NAT64)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules

Delete NAT Rule


Delete NAT Rule from VPC denoted by VPC ID, under NAT section denoted by <nat-id>. Under VPC there will be 2 different NATs(sections). (USER and NAT64) For more details related to NAT section please refer to PolicyNAT schema. 		DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}

Get NAT Rule


Get NAT Rule from VPC denoted by VPC ID, under NAT section
denoted by <nat-id>.
Under VPC there will be 2 different NATs(sections).
(USER and NAT64)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}

Create or update a Nat Rule


If a NAT Rule is not already present on VPC denoted by VPC ID,
under NAT section denoted by <nat-id>, create a new NAT Rule.
If it already exists, update the NAT Rule.
Under VPC there will be 2 different NATs(sections).
(USER and NAT64)
For more details related to NAT section please refer to PolicyNAT schema.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}

Update NAT Rule


Update NAT Rule on VPC denoted by VPC ID, under NAT section
denoted by <nat-id>.
Under VPC there will be 2 different NATs(sections).
(USER and NAT64)
For more details related to NAT section please refer to PolicyNAT schema.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}

Get NAT Rule Statistics


Get NAT Rule Statistics from VPC denoted by VPC ID, under NAT section
denoted by <nat-id>.
Under VPC there will be 2 different NATs(sections).
(USER and NAT64)
For more details related to NAT section please refer to PolicyNAT schema.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics

List NAT Rules Statistics


List NAT Rules Statistics from VPC denoted by VPC ID. 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/nat/statistics

Get realization failures for vpc


Retrieves only the resources with the reason not "SUCCESS". In case of failure or warning of the resource a reason object explaining the type of failure (ERROR, WARNING)
and the detailed message of what the user could do to remediate is captured.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/realization-failures (Experimental)

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

Get security policy realization failures for vpc


Retrieves only the resources with the reason not "SUCCESS". In case of failure or warning of the resource a reason object explaining the type of failure (ERROR, WARNING)
and the detailed message of what the user could do to remediate is captured.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/security-policies/realization-failures (Experimental)

Get VPC state


Get the VPC's runtime state that includes the gateway id and the HA details, if applicable.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/state

List VPC Static Routes


Paginated list of all VPC Static Routes
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes

Delete VPC static routes


Delete VPC static routes 		DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}

Read VPC static routes


Read VPC static routes 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}

Create or update a VPC static routes


If static routes for route-id are not already present, create
static routes. If it already exists, update static routes for route-id.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}

Create or update a VPC static routes


If static routes for route-id are not already present, create
static routes. If it already exists, replace the static routes for route-id.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/static-routes/{route-id}

Get VPC Statistics


Get VPC Statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/statistics

Get VPC Statistics Summary


Get VPC Statistics Summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/statistics/summary

Get VPC Status


Get VPC Status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/status (Experimental)

List of VPC Subnet


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

Delete VPC Subnet


Delete VPC Subnet.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}

Get VPC Subnet


Get VPC Subnet
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}

Create or update VPC Subnet


If a VPC Subnet with the subnet-id is not already present, create a new VPC Subnet.
If it already exists, update the VPC Subnet.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}

Update the VPC Subnet


Update the VPC Subnet.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}

Remove Subnet DHCP server leases


Remove Subnet DHCP server leases 		POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/actions/release-dhcp-server-leases

Get downlink port Address Resolution Protocol Proxy for VPC subnet


Returns ARP proxy table for downlink port connected to the VPC subnet.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/arp-proxy

Get downlink port Address Resolution Protocol Proxy for VPC subnet in CSV format


Returns ARP proxy table for downlink port connected to the VPC subnet in CSV format.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/arp-proxy/download

Get ARP table from VPC subnet (downlink)


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
interface (downlink) attaching subnet to VPC, on a edge
node specified in edge_path parameter.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/arp-table

Get ARP table from VPC subnet (downlink) in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in VSC
format for the interface (downlink) attaching subnet to VPC, on a edge
node specified in edge_path parameter.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/arp-table/download

Delete VPC Subnet bridge profile


Delete VPC Subnet bridge profile
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-profiles

Get VPC Subnet bridge profile


Get VPC Subnet Bridge Profile
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-profiles

Create or update the VPC subnet bridge profile


Patch VPC Subnet bridge profile
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-profiles

Create or update the VPC Subnet bridge profile


Put VPC Subnet bridge profile
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-profiles

Read VPC Subnet DHCP server statistics


Read VPC Subnet DHCP server statistics along with ip pool usage information. 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-server-config/stats

Read Vpc Subnet DHCP server status


Read Vpc Subnet DHCP server status 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-server-config/status

List all VPC Subnet DHCP static bindings


Paginated list of all VPC Subnet DHCP static binding instances
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs

Delete VPC Subnet DHCP static binding


Delete VPC Subnet DHCP static binding 		DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}

Read VPC Subnet DHCP static binding


Read VPC Subnet DHCP static binding 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}

Create or update VPC Subnet DHCP static binding


If binding with the binding-id is not already present,
create a new VPC Subnet DHCP static binding instance. If it already exists, replace
the existing VPC Subnet DHCP static binding instance with specified attributes.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}

Create or update VPC Subnet DHCP static binding


If binding with the binding-id is not already present,
create a new VPC Subnet DHCP static binding instance. If it already exists, replace
the existing VPC Subnet DHCP static binding instance with this object.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dhcp-static-binding-configs/{binding-id}

Get statistics for downlink router port


Get statistics for downlink router port
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/gateway-interface-statistics/summary

List of static ip pools of the Subnet.


Paginated list of static ip pools of the Subnet.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools

Read an IpAddressPool of VPC Subnet.


Read IpAddressPool with given Id.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}

List VPC Subnet ip allocations


List all the ip allocations for a VPC Subnet.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations

Records intent to release an IP from an IpPool.


Releases the IP that was allocated for this allocation request
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}

Get VPC Subnet ip allocation by ID


Get detail information on VPC Subnet ip allocation by giving ID.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}

Patch a VPC Subnet ip_allocations


Create a VPC Subnet ip-allocation if it does not exist based on the IDs, or update existing ip-allocation
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}

Create or update a VPC Subnet ip allocation


Create a VPC Subnet ip allocation if it does not exist based on the IDs, or update existing ip-allocation
information by replacing the port object already exists.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ip-pools/{ip-pool-id}/ip-allocations/{ip-allocation-id}

Get VPC subnet MAC table


Returns MAC table for a VPC subnet.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/mac-table

Get VPC subnet MAC table in CSV format


Returns MAC table for a VPC subnet in CSV format.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/mac-table/download

List VPC Subnet Ports


List all the ports for a VPC Subnet.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports

Delete a VPC Subnet Port


Delete a VPC Subnet Port by giving ID.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}

Get VPC Subnet Port by ID


Get detail information on VPC Subnet Port by giving ID.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}

Patch a VPC Subnet Port


Create a VPC Subnet port if it does not exist based on the IDs, or update existing port
information by replacing the port object fields which presents in the request body.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}

Create or update a VPC Subnet Port


Create a VPC Subnet port if it does not exist based on the IDs, or update existing port
information by replacing the port object already exists.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}

Get MAC table for VPC Subnet port


Returns MAC table for a VPC Subnet port
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/mac-table

Get VPC Subnet port MAC table in CSV


Returns MAC table for a VPC Subnet port
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/mac-table/csv

Get VPC Subnet port state


Returns VPC Subnet port state on enforcement point
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/state

Get Vpc subnet port statistics information


Get Vpc subnet port statistics information.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/statistics

Get Vpc subnet port status information


Get Vpc subnet port statistics information.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/ports/{port-id}/status

List Subnet DHCP server leases


List Subnet DHCP server leases 		GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/state/dhcp-server-leases

Get VPC Subnet statistics information


Get VPC Subnet statistics information.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/statistics

Get VPC Subnet status


Get VPC Subnet status
Provides status of the VPC subnet as well as network information such as gateway address, subnet mask,
dhcp server address, dhcp range, static ip pools, static ip pool range.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/status

List SubnetConnectionBindingMap specific Segment


List SubnetConnectionBindingMap specific subnet
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/subnet-connection-binding-maps

Deletes infra SubnetConnectionBindingMap.


Deletes infra SubnetConnectionBindingMap.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/subnet-connection-binding-maps/{map-id}

Read SubnetConnectionBindingMap


Read SubnetConnectionBindingMap.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/subnet-connection-binding-maps/{map-id}

Patch a vpc subnet connection binding map


Patch the vpc subnet connection binding map. If binding map corresponding to the the given values is
not present, the object will get created and if it is present it will be
updated. This is a full replace.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/subnet-connection-binding-maps/{map-id}

Patch a subnet connection binding map


Patch the subnet connection binding map. If binding map corresponding to the the given values is
not present, the object will get created and if it is present it will be
updated. This is a full replace.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/subnet-connection-binding-maps/{map-id}

Get subnet realization failures for vpc


Retrieves only the resources with the reason not "SUCCESS". In case of failure or warning of the resource a reason object explaining the type of failure (ERROR, WARNING)
and the detailed message of what the user could do to remediate is captured.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/realization-failures (Experimental)

List all unique tags.


Returns paginated list of all unique tags. Supports filtering by scope, tag and
source from which tags are synced. Supports starts with, ends with, equals and
contains operators on scope and tag values.
To filter tags by starts with on scope or tag, use '*' as suffix after the value.
To filter tags by ends with on scope or tag, use '*' as prefix before the value.
To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value.
Below special characters in the filter value needs to be escaped with hex values.
- Character '&' needs to be escaped as '%26'
- Character '[' needs to be escaped as '%5B'
- Character ']' needs to be escaped as '%5D'
- Character '+' needs to be escaped as '%2B'
- Character '#' needs to be escaped as '%23'
Sort option for list of unique tags is available only on tag and scope properties.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags

List all objects assigned with matching scope and tag values


Paginated list of all objects assigned with matching scope and tag values. Objects
are represented in form of resource reference. Sort option is available only on
target_type and target_display_name properties.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/effective-resources

Get details of tag bulk operation request


Get details of tag bulk operation request with which tag is applied or removed
on virtual machines.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}

Assign or Unassign tag on multiple Virtual Machines.


Tag can be assigned or unassigned on multiple objects. Supported object type is
restricted to Virtual Machine for now and support for other objects will be added
later. Permissions for tag bulk operation would be similar to virtual machine
tag permissions.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}

Get status of tag bulk operation


Get status of tag bulk operation with details of tag operation on each virtual machine.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/tags/vpc-tag-operations/{operation-id}/status

VC Folder Status for Vpc


Returns the VC Folder Status on vCenter for the Vpc.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vc-folder-status

Get groups for which the given VM is a member


Get policy groups for which the given VM is a member.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machine-group-associations

List all virtual machines for this VPC


This API lists the Virtual Machines for this VPC. Only those VMs are listed
which are connected to the subnets of this VPC.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machines

Apply tags on virtual machine under VPC


Allows an admin to apply multiple tags to a virtual machine under VPC. This operation
does not store the intent on the policy side. It applies the tag directly
on the specified enforcement point. This operation will replace the existing
tags on the virtual machine with the ones that have been passed. If the
application of tag fails on the enforcement point, then an error is
reported. The admin will have to retry the operation again. Policy
framework does not perform a retry. Failure could occur due to multiple
reasons. For e.g enforcement point is down, Enforcement point could not
apply the tag due to constraints like max tags limit exceeded, etc.
NOTE: The "virtual_machine_id" field in the payload will be ignored and the
virtual machine ID provided in the URL will be honored.
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-machines/{virtual-machine-id}/tags

Get groups for which the given VIF is a member


Get policy groups for which the given VIF is a member.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/virtual-network-interface-group-associations

List LBAppProfiles


Paginated list of all LBAppProfiles.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-app-profiles

Delete LBAppProfile and all the entities contained by this LBAppProfile


Delete the LBAppProfile along with all the entities contained
by this LBAppProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-app-profiles/{vpc-lb-app-profile-id}

Read LBAppProfile


Read a LBAppProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-app-profiles/{vpc-lb-app-profile-id}

Create or update a LBAppProfile


If a LBAppProfile with the vpc-lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-app-profiles/{vpc-lb-app-profile-id}

Create or update a LBAppProfile


If a LBAppProfile with the vpc-lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-app-profiles/{vpc-lb-app-profile-id}

List LBClientSslProfiles


Paginated list of all LBClientSslProfiles.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-client-ssl-profiles

Delete LBClientSslProfile and all the entities contained by this LBClientSslProfile


Delete the LBClientSslProfile along with all the entities contained
by this LBClientSslProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-client-ssl-profiles/{vpc-lb-client-ssl-profile-id}

Read LBClientSslProfile


Read a LBClientSslProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-client-ssl-profiles/{vpc-lb-client-ssl-profile-id}

Create or update a LBClientSslProfile


If a LBClientSslProfile with the vpc-lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-client-ssl-profiles/{vpc-lb-client-ssl-profile-id}

Create or update a LBClientSslProfile


If a LBClientSslProfile with the vpc-lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-client-ssl-profiles/{vpc-lb-client-ssl-profile-id}

List LBMonitorProfiles specified Vpc


Paginated list of all LBMonitorProfiles specified Vpc.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-monitor-profiles

Delete LBMonitorProfile and all the entities contained by this LBMonitorProfile


Delete the LBMonitorProfile along with all the entities contained
by this LBMonitorProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-monitor-profiles/{vpc-lb-monitor-profile-id}

Read LBMonitorProfile


Read a LBMonitorProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-monitor-profiles/{vpc-lb-monitor-profile-id}

Create or update a LBMonitorProfile


If a LBMonitorProfile with the vpc-lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-monitor-profiles/{vpc-lb-monitor-profile-id}

Create or update a LBMonitorProfile


If a LBMonitorProfile with the vpc-lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-monitor-profiles/{vpc-lb-monitor-profile-id}

Get LB node capacity


API is used to retrieve available load balancer capacity status for all
service clusters shared with VPC.
Currently Edge cluster is supported as service cluster.
If the parameter ?service_cluster_path=<service-cluster-path> exists,
then API only shows the available load balancer capacity status for this
specific service cluster.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-node-capacity-status

List LBPersistenceProfiles for the specified Vpc


Paginated list of all LBPersistenceProfiles specified Vpc.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-persistence-profiles

Delete LBPersistenceProfile and all the entities contained by this LBPersistenceProfile


Delete the LBPersistenceProfile along with all the entities
contained by this LBPersistenceProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-persistence-profiles/{vpc-lb-persistence-profile-id}

Read LBPersistenceProfile


Read a LBPersistenceProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-persistence-profiles/{vpc-lb-persistence-profile-id}

Create or update a LBPersistenceProfile


If a LBPersistenceProfile with the vpc-lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-persistence-profiles/{vpc-lb-persistence-profile-id}

Create or update a LBPersistenceProfile


If a LBPersistenceProfile with the vpc-lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-persistence-profiles/{vpc-lb-persistence-profile-id}

List LBPools


Paginated list of all LBPools.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-pools

Delete LBPool and all the entities contained by this LBPool


Delete the LBPool along with all the entities contained
by this LBPool.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-pools/{vpc-lb-pool-id}

Read LBPool


Read a LBPool.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-pools/{vpc-lb-pool-id}

Create or update a LBPool


If a LBPool with the vpc-lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-pools/{vpc-lb-pool-id}

Create or update a LBPool


If a LBPool with the vpc-lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-pools/{vpc-lb-pool-id}

List LBServerSslProfiles


Paginated list of all LBServerSslProfiles.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-server-ssl-profiles

Delete LBServerSslProfile and all the entities contained by this LBServerSslProfile


Delete the LBServerSslProfile along with all the entities contained
by this LBServerSslProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-server-ssl-profiles/{vpc-lb-server-ssl-profile-id}

Read LBServerSslProfile


Read a LBServerSslProfile.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-server-ssl-profiles/{vpc-lb-server-ssl-profile-id}

Create or update a LBServerSslProfile


If a LBServerSslProfile with the vpc-lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-server-ssl-profiles/{vpc-lb-server-ssl-profile-id}

Create or update a LBServerSslProfile


If a LBServerSslProfile with the vpc-lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-server-ssl-profiles/{vpc-lb-server-ssl-profile-id}

List LBVirtualServers


Paginated list of all LBVirtualServers.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-virtual-servers

Delete LBVirtualServer and all the entities contained by this LBVirtualServer.


Delete the LBVirtualServer along with all the entities contained by
this LBVirtualServer.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-virtual-servers/{vpc-lb-virtual-server-id}

Read LBVirtualServer


Read a LBVirtualServer.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-virtual-servers/{vpc-lb-virtual-server-id}

Create or update a LBVirtualServer


If a LBVirtualServer with the vpc-lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-virtual-servers/{vpc-lb-virtual-server-id}

Create or update a LBVirtualServer


If a LBVirtualServer with the vpc-lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lb-virtual-servers/{vpc-lb-virtual-server-id}

List load balancers


Paginated list of all load balancers.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs

Delete the load balancer and all the entities contained by this load balancer


Delete the load balancer and all the entities contained by
this load balancer.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}

Read a load balancer


Read a load balancer.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}

Create or update a load balancer


If a load balancer with the vpc-lb-id doesn't exist, create a new Load
Balancer. If it has already existed, update the load balancer.
This is a full replacement.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}

Create or update a load balancer


If a load balancer with the vpc-lb-id doesn't exist, create a new Load
Balancer. If it has already existed, update the load balancer.
This is a full replacement.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}

Get load balancer status information


Get load balancer detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/detailed-status

Get load balancer statistics information


Get load balancer statistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/statistics

Get load balancer usage information


Get load balancer usage information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/usage

Get LBPool status information


Get LBPool detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/vpc-lb-pools/{vpc-lb-pool-id}/detailed-status

Get LBPool statistics information


Get LBPoolStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/vpc-lb-pools/{vpc-lb-pool-id}/statistics

Get LBVirtualServer status information


Get LBVirtualServer detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/vpc-lb-virtual-servers/{vpc-lb-virtual-server-id}/detailed-status

Get LBVirtualServer statistics information


Get LBVirtualServerStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.

NSX Load Balancer availability in terms of use-cases and editions is
specified in NSX Feature and Edition Guide. Please review before consuming
those APIs.
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/vpc-lbs/{vpc-lb-id}/vpc-lb-virtual-servers/{vpc-lb-virtual-server-id}/statistics
Additional Links