List Leases

GET

///lease

GET

/lease

$ curl -G /lease \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0 \
>      -d ip_version=4 \
>      -d limit=100 \
>      --data-urlencode search=hostname:printer \
>      --data-urlencode subnet=192.168.1.0/24

1 {
2   "leases": [
3     {
4       "cltt": 1700000000,
5       "expires_at": "2024-01-15T09:30:00Z",
6       "ip_address": "192.168.1.45",
7       "state": 2,
8       "valid_lft": 3600,
9       "client_id": "client-12345",
10       "duid": "00:01:00:01:23:45:67:89:ab:cd:ef:01:23:45",
11       "hostname": "office-printer-01",
12       "hw_address": "00:1A:2B:3C:4D:5E",
13       "subnet": "192.168.1.0/24"
14     }
15   ],
16   "next_cursor": "eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiIyMDIzLTEyLTAxVDA5OjMwOjAwWiJ9"
17 }

Return a cursor-paginated, optionally filtered page of normalized leases.

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

leaseslist of objects

next_cursorstring or null

Errors

422

Unprocessable Entity Error