NSX-T Data Center REST API

Associated URIs:

API Description API Path

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)