NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List VPC transit gateways Read VPC transit gateways	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways
List TransitGateway NAT types. List all NAT sections under the given TransitGateway	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat
GET TransitGateway NAT types /section Get either of the two supported sections (USER and NAT64) under the given Transit Gateway. The USER section allows IPV4 based NAT rules, while the NAT64 rules allow translating IPV6 packets to IPV4 packets.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}
List NAT Rules List NAT Rules under the given Transit Gateway, under the given NAT section.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}/nat-rules
Delete NAT Rule Delete NAT Rule under the given Transit Gateway, under the given NAT section.	DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Get NAT Rule Get NAT Rule from the given Transit Gateway, under the given NAT section.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Create or update a Nat Rule If a NAT Rule is not already present in the transit gateway denoted by the TGW ID, under the NAT section, create a new NAT Rule. If it already exists, update the NAT Rule.	PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Update NAT Rule Update NAT Rule on VPC denoted by Transit Gateway ID, under the given NAT section.	PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{tgw-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Delete VPC transit gateway Delete VPC transit gateway	DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}
Read VPC transit gateway Read VPC transit gateway	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}
Create or Update VPC transit gateway Create or Update VPC transit gateway	PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}
Create or Update VPC transit gateway Create or Update VPC transit gateway	PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}
Get Transit Gateway Address Resolution Protocol Proxies Returns ARP proxy table for a TGW.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/arp-proxies
Get Transit Gateway Address Resolution Protocol Proxies in CSV format Returns ARP proxy table for a TGW in CSV format.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/arp-proxies/download
List transit gateway attachments List transit gateway attachments	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments
Delete transit gateway attachment Delete transit gateway attachment	DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{attachment-id}
Read transit gateway attachment Read transit gateway attachment	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{attachment-id}
Create or Update transit gateway attachment Create or Update transit gateway attachment	PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{attachment-id}
Create or Update transit gateway attachment Create or Update transit gateway attachment	PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{attachment-id}
Get transit gateway attachment statistics. Retrieve the total tx, rx dropped, total bytes, total packets of all traffic that flows to the TGW attachment.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{attachment-id}/statistics
List networks advertised to the TGW external attachment Returns information about all networks which are advertised to the TGW external attachment.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{external-attachment-id}/advertised-networks
List networks advertised to the TGW external attachment in CSV format Returns information about all networks which are advertised to the TGW external attachment in CSV format.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/attachments/{external-attachment-id}/advertised-networks/download
Get forwarding table from TGW Get forwarding table from TGW.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/forwarding-table
Get forwarding table from TGW in CSV format Get forwarding table from TGW in CSV format.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/forwarding-table/download
Get transit gateway NAT Rule Statistics Get transit gateway NAT Rule Statistics from transit gateway denoted by transit-gateway-id, under NAT section denoted by <nat-id>. Under transit gateway 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}/transit-gateways/{transit-gateway-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
List NAT Rules Statistics Get NAT Rule Statistics from Transit Gateway denoted by Transit Gateway ID.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/nat/statistics
Get transit gateway realization failures 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}/transit-gateways/{transit-gateway-id}/realization-failures (Experimental)
Get routing table from TGW Get routing table from TGW.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/routing-table
Get routing table from TGW in CSV format Get routing table from TGW in CSV format.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/routing-table/download
Get Transit Gateway state Get the transit gateway's runtime state that includes the transport node and the HA details, if applicable.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/state
Get Transit Gateway statistics Retrieve the total tx, rx dropped, total bytes, total packets of all traffic exchanged between the TGW and its attachments (VPC's).	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/statistics
Get current status of TGW Get current status of VPC TGW.	GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/status