NSX-T Data Center REST API

List of VPC

Paginated list of VPC.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs
Request Headers:
n/a
Query Parameters:
VpcListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-2/vpcs

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
VpcListResult+

Example Response:

{ "results": [ { "service_gateway": { "disable": false, "qos_config": { "ingress_qos_profile_path": "/orgs/default/projects/project-1/infra/gateway-qos-profiles/ingress", "egress_qos_profile_path": "/orgs/default/projects/project-1/infra/gateway-qos-profiles/egress" }, "auto_snat": true }, "default_gateway_path": "/infra/tier-0s/pepsi", "site_infos": [ { "edge_cluster_paths": [ "/infra/sites/default/enforcement-points/default/edge-clusters/4a033a2f-d42e-421d-a41b-33333656278a" ], "site_path": "/infra/sites/default" } ], "external_ipv4_blocks": [ "/infra/ip-blocks/public-1" ], "ipv6_block": [ "/infra/ip-blocks/public-1" ], "private_ipv4_blocks": [ "/orgs/default/projects/project-1/infra/ip-blocks/private" ], "ip_address_type": "IPV4", "ipv6_profile_paths": [ "/infra/ipv6-ndra-profiles/default", "/infra/ipv6-dad-profiles/default" ], "subnet_profiles": {}, "dhcp_config": { "enable_dhcp": true, "dns_client_config": { "dns_server_ips": [ "value: \"192.168.1.25\"\n" ] } }, "short_id": "vpc-2", "resource_type": "Vpc", "id": "vpc-2", "display_name": "vpc-2", "path": "/orgs/default/projects/project-1/vpcs/vpc-2", "relative_path": "vpc-2", "parent_path": "/orgs/default/projects/project-1", "unique_id": "21064fec-0850-4468-8b30-1c761a52c465", "realization_id": "21064fec-0850-4468-8b30-1c761a52c465", "owner_id": "14565b02-e277-4ac8-a6b8-2d25e5aab9c7", "origin_site_id": "14565b02-e277-4ac8-a6b8-2d25e5aab9c7", "marked_for_delete": false, "overridden": false, "_create_time": 1661225865141, "_create_user": "admin", "_last_modified_time": 1661225865141, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 1, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_vpc

Additional Errors: