NSX-T Data Center REST API

Associated URIs:

API Description API Path

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

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)

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

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)

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