ServicesDHCP ServiceDHCP API

List Pools

View as Markdown

Return a cursor-paginated, optionally filtered configured-pool page.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Query parameters

ip_versionenumOptional
Supported DHCP address families.
Allowed values:
limitintegerOptional1-500Defaults to 100
cursorstring or nullOptional1-128 characters
searchstring or nullOptional<=256 characters
subnetstring or nullOptionalformat: "ipvanynetwork"

Response

Successful Response
poolslist of objects
total_countinteger
next_cursorstring or null

Errors

422
Unprocessable Entity Error