NSX-T Data Center REST API
Associated URIs:
| API Description | API Path |
|---|---|
List of VPC SubnetPaginated list of VPC Subnet. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets
|
Delete VPC SubnetDelete VPC Subnet. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Get VPC SubnetGet VPC Subnet |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Create or update VPC SubnetIf 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 SubnetUpdate the VPC Subnet. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}
|
Get downlink port Address Resolution Protocol Proxy for VPC subnetReturns 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 formatReturns 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 formatReturns 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
|
List all bridge connections under a vpc subnetList all bridge connections under a vpc subnet specific subnet |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-connections
(Experimental)
|
Delete VPC Subnet bridge profileDelete VPC Subnet bridge profile |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-connections/{bridge-connection-id}
(Experimental)
|
Get VPC Subnet bridge connectionGet VPC Subnet Bridge Connection |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-connections/{bridge-connection-id}
(Experimental)
|
Create or update the Bridge ConnectionPatch Bridge Connection |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-connections/{bridge-connection-id}
(Experimental)
|
Create or update the VPC Subnet bridge profilePut VPC Subnet bridge profile |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/bridge-connections/{bridge-connection-id}
(Experimental)
|
List VPC Subnet Dynamic IP Address Reservation.List all the Dynamic IP Address Reservation for a VPC Subnet. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dynamic-ip-reservations
|
Records intent to release Dynamic IP Reservations from IpPool.Releases the IP that was allocated for this DynamicIpReservation request |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dynamic-ip-reservations/{dynamic-ip-reservation-id}
|
Get a VPC Subnet Dynamic IP Address Reservation.Read VPC Subnet Dynamic IP Address Reservation with specific id. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dynamic-ip-reservations/{dynamic-ip-reservation-id}
|
Patch a VPC Subnet IP Address Reservation.If no DynamicIpAddressReservation of the specified ID is found, then a new DynamicIpAddressReservation is created. A DynamicIpAddressReservation cannot be updated once created. |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dynamic-ip-reservations/{dynamic-ip-reservation-id}
|
Create or update a VPC Subnet IP Address Reservation.If no DynamicIpAddressReservation of the specified ID is found, then a new DynamicIpAddressReservation is created. A DynamicIpAddressReservation cannot be updated once created. |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/dynamic-ip-reservations/{dynamic-ip-reservation-id}
|
Get statistics for downlink router portGet 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
(Deprecated)
|
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 allocationsList 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 IDGet 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_allocationsCreate 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 allocationCreate 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 tableReturns 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 formatReturns 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
|
Get Vpc Subnet state informationReturns Vpc subnet state information. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/state
|
Get VPC Subnet statistics informationGet VPC Subnet statistics information. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/subnets/{subnet-id}/statistics
|
Get VPC Subnet statusGet 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
|
Get subnet realization failures for vpcRetrieves 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)
|