NSX-T Data Center REST API
Associated URIs:
| API Description | API Path |
|---|---|
List of VPC AttachmentPaginated list of VPC Attachment. |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments
|
Delete VPC AttachmentDelete VPC Attachment. **IMPORTANT WARNING:** Deleting a VPC attachment will remove the connectivity profile association and all related network configurations, which may cause traffic disruption: • **Auto SNAT Rules**: If the current connectivity profile has "Default Outbound NAT" enabled, all system-generated SNAT rules will be automatically deleted. This will immediately break outbound connectivity for private subnets that rely on these rules. • **External IP Allocations**: Any IP addresses allocated from external IP blocks for auto SNAT will be released and may be reassigned to other resources. • **Transit Gateway Connections**: All transit gateway connections and routing configurations associated with the connectivity profile will be removed. **Before proceeding with deletion:** 1. Verify that removing auto SNAT won't break critical application traffic 2. Plan for potential downtime during the transition This operation is typically performed as part of changing VPC connectivity profiles. Consider using PATCH or PUT operations to update the connectivity profile instead of deleting and recreating attachments. |
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}
|
Get VPC AttachmentGet VPC Attachment |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}
|
Update VPC AttachmentEach VPC has one attachment. This API will update the VPC attachment. **IMPORTANT WARNING for Connectivity Profile Changes:** When changing the vpc_connectivity_profile field, this operation may cause immediate traffic disruption: • **Auto SNAT Changes**: If switching between connectivity profiles with different "Default Outbound NAT" settings (enabled vs disabled), existing auto SNAT rules will be deleted and new ones may be created. This can break outbound connectivity for private subnets during the transition. • **External IP Block Changes**: If the new connectivity profile uses different external IP blocks, existing SNAT IP allocations will be released and new ones allocated, potentially changing translated IP addresses. • **Transit Gateway Changes**: Switching to a connectivity profile with a different transit gateway will update routing paths and may cause temporary connectivity loss. **Best Practices:** 1. Plan for potential downtime during the profile transition 2. Test connectivity profile changes in non-production environments first |
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}
|
Update the VPC attachmentUpdate the VPC attachment. **IMPORTANT WARNING for Connectivity Profile Changes:** When changing the vpc_connectivity_profile field, this operation may cause immediate traffic disruption: • **Auto SNAT Changes**: If switching between connectivity profiles with different "Default Outbound NAT" settings (enabled vs disabled), existing auto SNAT rules will be deleted and new ones may be created. This can break outbound connectivity for private subnets during the transition. • **External IP Block Changes**: If the new connectivity profile uses different external IP blocks, existing SNAT IP allocations will be released and new ones allocated, potentially changing translated IP addresses. • **Transit Gateway Changes**: Switching to a connectivity profile with a different transit gateway will update routing paths and may cause temporary connectivity loss. **Best Practices:** 1. Plan for potential downtime during the profile transition 2. Test connectivity profile changes in non-production environments first |
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/attachments/{vpc-attachment-id}
|
Get VPC Statistics SummaryGet VPC Statistics Summary |
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/statistics/summary
|
VC Folder Status for VpcReturns 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
|