NSX-T Data Center REST API

List IpAddressPool Allocations

Returns information about which addresses have been allocated from a
specified IP address pool in policy.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/ip-pools/<ip-pool-id>/ip-allocations
Request Headers:
n/a
Query Parameters:
PolicyListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/ip-pools/IpPool-Tenant-1/ip-allocations

Successful Response:

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

Example Response:

{ "result_count": 2, "results": [ { "resource_type": "IpAddressAllocation", "id": "ip-1-allocation", "display_name": "ip-1-allocation", "path": "/infra/ip-pools/IpPool-Tenant-1/ip-allocations/ip-1-allocation", "relative_path": "ip-1-allocation", "parent_path": "/infra/ip-pools/IpPool-Tenant-1", "marked_for_delete": false, "allocation_ip": "10.0.0.5" "_create_user": "admin", "_create_time": 1543966814544, "_last_modified_user": "admin", "_last_modified_time": 1543966814544, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "resource_type": "IpAddressAllocation", "id": "ip-2-allocation", "display_name": "ip-2-allocation", "path": "/infra/ip-pools/IpPool-Tenant-1/ip-allocations/ip-2-allocation", "relative_path": "ip-2-allocation", "parent_path": "/infra/ip-pools/IpPool-Tenant-1", "marked_for_delete": false, "allocation_ip": "10.0.0.6" "_create_user": "admin", "_create_time": 1543966814545, "_last_modified_user": "admin", "_last_modified_time": 1543966814544, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ] }

Required Permissions:

read

Feature:

policy_ipam

Additional Errors: