Get a paginated list of a DHCP server's IP pools

List the ip pools of a logical DHCP server with pagination support.

Request:

Method:

GET

URI Path(s):

/api/v1/dhcp/servers/<server-id>/ip-pools

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET /api/v1/dhcp/servers/d7f425da-25d2-4e5e-ae9e-ea112375971d/ip-pools

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DhcpIpPoolListResult+

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	Paginated list of DHCP ip pools A paginated list of DHCP ip pools.	array of DhcpIpPool	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:

{ "cursor" : "0036073b1c6e-8591-4621-af6c-5f3dcdd4059fDHCP-ip-pool-2", "result_count" : 1, "results" : [ { "resource_type" : "DhcpIpPool", "id" : "073b1c6e-8591-4621-af6c-5f3dcdd4059f", "display_name" : "DHCP-ip-pool-2", "lease_time" : 86400, "gateway_ip" : "192.168.150.1", "allocation_ranges" : [ { "start" : "192.168.150.100", "end" : "192.168.150.200" } ], "error_threshold" : 100, "warning_threshold" : 80, "_create_time" : 1478305498175, "_create_user" : "admin", "_last_modified_user" : "admin", "_system_owned" : false, "_last_modified_time" : 1478305498175, "_revision" : 0 } ] }

Get a paginated list of a DHCP server's IP pools

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

DhcpIpPoolListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: