NSX-T Data Center REST API

List VPC ip allocations

List all the ip allocations for a VPC.

Request:

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

Successful Response:

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

Example Response:

{ "results": [ { "ip_address_type": "IPV4", "ip_address_block_visibility": "EXTERNAL", "allocation_ip": "192.168.0.2", "resource_type": "VpcIpAddressAllocation", "id": "ip-1", "display_name": "ip-1", "path": "/orgs/default/projects/project-1/vpcs/vpc-2/ip-address-allocations/ip-1", "relative_path": "ip-1", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-2", "remote_path": "", "unique_id": "3d1aa8b5-9893-4892-8eec-004a6778df47", "realization_id": "3d1aa8b5-9893-4892-8eec-004a6778df47", "owner_id": "be6c9296-48cb-4f6f-a80d-c3c68d95c4e1", "origin_site_id": "be6c9296-48cb-4f6f-a80d-c3c68d95c4e1", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_time": 1663664251128, "_create_user": "admin", "_last_modified_time": 1663664251128, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 }, { "ip_address_type": "IPV4", "ip_address_block_visibility": "EXTERNAL", "allocation_ip": "192.168.0.3", "resource_type": "VpcIpAddressAllocation", "id": "ip-2", "display_name": "ip-2", "path": "/orgs/default/projects/project-1/vpcs/vpc-2/ip-address-allocations/ip-2", "relative_path": "ip-2", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-2", "remote_path": "", "unique_id": "f336791f-487c-41f8-aad9-f1518f208f15", "realization_id": "f336791f-487c-41f8-aad9-f1518f208f15", "owner_id": "be6c9296-48cb-4f6f-a80d-c3c68d95c4e1", "origin_site_id": "be6c9296-48cb-4f6f-a80d-c3c68d95c4e1", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_time": 1663664654750, "_create_user": "admin", "_last_modified_time": 1663664654750, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 2, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_ipam

Additional Errors: