---
title: "List DHCP leases"
method: GET
path: "/network/dhcp/lease"
tags: ["Network"]
---

# List DHCP leases

`GET /network/dhcp/lease`

Retrieve active runtime leases and configured static DHCP leases

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseGithubComAlchemillahqSylveInternalInterfacesServicesNetworkLeases
  - `data` GithubComAlchemillahqSylveInternalInterfacesServicesNetworkLeases
    - `db` GithubComAlchemillahqSylveInternalDbModelsNetworkDHCPStaticLease[]
      - `comments` string
      - `createdAt` string
      - `dhcpRange` GithubComAlchemillahqSylveInternalDbModelsNetworkDHCPRange
        - `createdAt` string
        - `endIp` string
        - `expiry` integer
        - `id` integer
        - `manualSwitch` GithubComAlchemillahqSylveInternalDbModelsNetworkManualSwitch
          - `bridge` string
          - `createdAt` string
          - `id` integer
          - `name` string
          - `updatedAt` string
        - `manualSwitchId` integer
        - `raOnly` boolean
        - `slaac` boolean
        - `standardSwitch` GithubComAlchemillahqSylveInternalDbModelsNetworkStandardSwitch
          - `address` string
          - `address6` string
          - `address6Id` integer
          - `address6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
            - `autoUpdate` boolean
            - `createdAt` string
            - `description` string
            - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
              - …
            - `id` integer
            - `isUsed` boolean
            - `isUsedBy` string — "", "dhcp" for now
            - `lastRefreshAt` string
            - `lastRefreshError` string
            - `name` string
            - `refreshIntervalSeconds` integer
            - `resolutionChecksum` string
            - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
              - …
            - `sourceChecksum` string
            - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
            - `updatedAt` string
          - `addressId` integer
          - `addressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
            - `autoUpdate` boolean
            - `createdAt` string
            - `description` string
            - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
              - …
            - `id` integer
            - `isUsed` boolean
            - `isUsedBy` string — "", "dhcp" for now
            - `lastRefreshAt` string
            - `lastRefreshError` string
            - `name` string
            - `refreshIntervalSeconds` integer
            - `resolutionChecksum` string
            - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
              - …
            - `sourceChecksum` string
            - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
            - `updatedAt` string
          - `bridgeName` string
          - `createdAt` string
          - `defaultRoute` boolean
          - `dhcp` boolean
          - `disableBridgeOffloads` boolean — DisableBridgeOffloads keeps FreeBSD from changing bridge-member capabilities as transient tap and epair interfaces come and go. Sorts flapping issues (Please tell @hayzam if you faced flapping before/after enabling this option).
          - `disableIPv6` boolean
          - `gateway6AddressId` integer
          - `gateway6AddressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
            - `autoUpdate` boolean
            - `createdAt` string
            - `description` string
            - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
              - …
            - `id` integer
            - `isUsed` boolean
            - `isUsedBy` string — "", "dhcp" for now
            - `lastRefreshAt` string
            - `lastRefreshError` string
            - `name` string
            - `refreshIntervalSeconds` integer
            - `resolutionChecksum` string
            - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
              - …
            - `sourceChecksum` string
            - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
            - `updatedAt` string
          - `gateway6Manual` string
          - `gatewayAddressId` integer
          - `gatewayAddressObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
            - `autoUpdate` boolean
            - `createdAt` string
            - `description` string
            - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
              - …
            - `id` integer
            - `isUsed` boolean
            - `isUsedBy` string — "", "dhcp" for now
            - `lastRefreshAt` string
            - `lastRefreshError` string
            - `name` string
            - `refreshIntervalSeconds` integer
            - `resolutionChecksum` string
            - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
              - …
            - `sourceChecksum` string
            - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
            - `updatedAt` string
          - `gatewayManual` string
          - `id` integer
          - `mtu` integer
          - `name` string
          - `network6Id` integer
          - `network6Manual` string
          - `network6Obj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
            - `autoUpdate` boolean
            - `createdAt` string
            - `description` string
            - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
              - …
            - `id` integer
            - `isUsed` boolean
            - `isUsedBy` string — "", "dhcp" for now
            - `lastRefreshAt` string
            - `lastRefreshError` string
            - `name` string
            - `refreshIntervalSeconds` integer
            - `resolutionChecksum` string
            - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
              - …
            - `sourceChecksum` string
            - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
            - `updatedAt` string
          - `networkId` integer
          - `networkManual` string
          - `networkObj` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
            - `autoUpdate` boolean
            - `createdAt` string
            - `description` string
            - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
              - …
            - `id` integer
            - `isUsed` boolean
            - `isUsedBy` string — "", "dhcp" for now
            - `lastRefreshAt` string
            - `lastRefreshError` string
            - `name` string
            - `refreshIntervalSeconds` integer
            - `resolutionChecksum` string
            - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
              - …
            - `sourceChecksum` string
            - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
            - `updatedAt` string
          - `ports` GithubComAlchemillahqSylveInternalDbModelsNetworkNetworkPort[]
            - `id` integer
            - `name` string
            - `switch` GithubComAlchemillahqSylveInternalDbModelsNetworkStandardSwitch — recursive
            - `switchId` integer
          - `private` boolean
          - `slaac` boolean
          - `updatedAt` string
          - `vlan` integer
        - `standardSwitchId` integer
        - `startIp` string
        - `type` string
        - `updatedAt` string
      - `dhcpRangeId` integer
      - `duidObject` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `duidObjectId` integer
      - `expiry` integer
      - `hostname` string
      - `id` integer
      - `ipObject` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `ipObjectId` integer — Per-range uniqueness on each object reference (Postgres & MySQL allow multiple NULLs)
      - `macObject` GithubComAlchemillahqSylveInternalDbModelsNetworkObject
        - `autoUpdate` boolean
        - `createdAt` string
        - `description` string
        - `entries` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectEntry[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `updatedAt` string
          - `value` string — IP, CIDR, port, country code, FQDN, etc.
        - `id` integer
        - `isUsed` boolean
        - `isUsedBy` string — "", "dhcp" for now
        - `lastRefreshAt` string
        - `lastRefreshError` string
        - `name` string
        - `refreshIntervalSeconds` integer
        - `resolutionChecksum` string
        - `resolutions` GithubComAlchemillahqSylveInternalDbModelsNetworkObjectResolution[]
          - `createdAt` string
          - `id` integer
          - `objectId` integer
          - `resolvedIp` string — deprecated mirror for resolved IP entries
          - `resolvedValue` string
          - `updatedAt` string
        - `sourceChecksum` string
        - `type` string — "Host", "Mac", "Network", "Port", "Country", "List", "FQDN", "DUID"
        - `updatedAt` string
      - `macObjectId` integer
      - `updatedAt` string
    - `file` GithubComAlchemillahqSylveInternalInterfacesServicesNetworkFileLeases[]
      - `clientId` string
      - `duid` string
      - `expiry` integer
      - `hostname` string
      - `iaid` string
      - `ip` string
      - `mac` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.net/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alchemillahq/sylve-api/revisions/7a7bea85004e/schema)