Skip to navigation
ServicesDHCP ServiceDHCP API

Get Reservation

View as MarkdownOpen in Claude
Return one normalized reservation from the selected DHCP configuration.

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.

Path parameters

ip_addressstringRequiredformat: "ipvanyaddress"

Query parameters

ip_versionenum or nullOptional
Supported DHCP address families.
Allowed values:

Response

Successful Response
hostnamestringOptionalDefaults to
identifierstring or nullOptional
identifier_typestring or nullOptional
ip_addressstring or nullOptionalformat: "ipvanyaddress"
subnetstring or nullOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error