NSX-T Data Center REST API

List IP Pool Allocations

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

Request:

Method:

GET

URI Path(s):

/api/v1/pools/ip-pools/<pool-id>/allocations

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/pools/ip-pools/4b1c354d-bf7a-42ce-8e27-57e75e803fa8/allocations

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AllocationIpAddressListResult+

AllocationIpAddressListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Pool allocation list results	array of AllocationIpAddress	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 4, "results": [ { "allocation_id": "192.168.1.1" }, { "allocation_id": "192.168.1.3" }, { "allocation_id": "192.168.1.2" }, { "allocation_id": "192.168.1.4" } ] }

Required Permissions:

read

Feature:

groups_ip_pools

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable