List DHCP leases
GET
/network/dhcp/lease
const url = 'https://sylve.lan:8181/api/network/dhcp/lease';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://sylve.lan:8181/api/network/dhcp/lease \ --header 'Authorization: <Authorization>'Retrieve active runtime leases and configured static DHCP leases
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Success
Media typeapplication/json
object
data
object
db
Array<object>
object
comments
string
createdAt
string
dhcpRange
object
createdAt
string
endIp
string
expiry
integer
id
integer
manualSwitch
object
bridge
string
createdAt
string
id
integer
name
string
updatedAt
string
manualSwitchId
integer
raOnly
boolean
slaac
boolean
standardSwitch
object
address
string
address6
string
address6Id
integer
address6Obj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
addressId
integer
addressObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
bridgeMacMode
string
bridgeMacObject
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
bridgeMacObjectId
integer
bridgeMacSourcePort
string
bridgeName
string
createdAt
string
defaultRoute
DefaultRoute owns the IPv4 default route for static or DHCP addressing.
boolean
defaultRoute6
DefaultRoute6 owns the IPv6 default route for static or SLAAC addressing.
boolean
dhcp
boolean
disableBridgeOffloads
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).
boolean
disableIPv6
boolean
gateway6AddressId
integer
gateway6AddressObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
gateway6Manual
string
gatewayAddressId
integer
gatewayAddressObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
gatewayManual
string
id
integer
mtu
integer
name
string
network6Id
integer
network6Manual
string
network6Obj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
networkId
integer
networkManual
string
networkObj
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
ports
Array<object>
object
id
integer
name
string
switch
object recursive
switchId
integer
private
boolean
slaac
boolean
updatedAt
string
vlan
integer
standardSwitchId
integer
startIp
string
type
string
updatedAt
string
dhcpRangeId
integer
duidObject
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
duidObjectId
integer
expiry
integer
hostname
string
id
integer
ipObject
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
ipObjectId
Per-range uniqueness on each object reference (Postgres & MySQL allow multiple NULLs)
integer
macObject
object
autoUpdate
boolean
createdAt
string
description
string
entries
Array<object>
object
createdAt
string
id
integer
objectId
integer
updatedAt
string
value
IP, CIDR, port, country code, FQDN, etc.
string
id
integer
isUsed
boolean
isUsedBy
“”, “dhcp” for now
string
lastRefreshAt
string
lastRefreshError
string
name
string
refreshIntervalSeconds
integer
resolutionChecksum
string
resolutions
Array<object>
object
createdAt
string
id
integer
objectId
integer
resolvedIp
Deprecated mirror for resolved IP entries
string
resolvedValue
string
updatedAt
string
sourceChecksum
string
type
“Host”, “Mac”, “Network”, “Port”, “Country”, “List”, “FQDN”, “DUID”
string
updatedAt
string
macObjectId
integer
updatedAt
string
file
Array<object>
object
clientId
string
duid
string
expiry
integer
hostname
string
iaid
string
ip
string
mac
string
error
string
message
string
status
string
Examplegenerated
{ "data": { "db": [ { "comments": "example", "createdAt": "example", "dhcpRange": { "createdAt": "example", "endIp": "example", "expiry": 1, "id": 1, "manualSwitch": { "bridge": "example", "createdAt": "example", "id": 1, "name": "example", "updatedAt": "example" }, "manualSwitchId": 1, "raOnly": true, "slaac": true, "standardSwitch": { "address": "example", "address6": "example", "address6Id": 1, "address6Obj": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "addressId": 1, "addressObj": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "bridgeMacMode": "example", "bridgeMacObject": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "bridgeMacObjectId": 1, "bridgeMacSourcePort": "example", "bridgeName": "example", "createdAt": "example", "defaultRoute": true, "defaultRoute6": true, "dhcp": true, "disableBridgeOffloads": true, "disableIPv6": true, "gateway6AddressId": 1, "gateway6AddressObj": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "gateway6Manual": "example", "gatewayAddressId": 1, "gatewayAddressObj": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "gatewayManual": "example", "id": 1, "mtu": 1, "name": "example", "network6Id": 1, "network6Manual": "example", "network6Obj": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "networkId": 1, "networkManual": "example", "networkObj": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "ports": [ { "id": 1, "name": "example", "switch": {}, "switchId": 1 } ], "private": true, "slaac": true, "updatedAt": "example", "vlan": 1 }, "standardSwitchId": 1, "startIp": "example", "type": "example", "updatedAt": "example" }, "dhcpRangeId": 1, "duidObject": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "duidObjectId": 1, "expiry": 1, "hostname": "example", "id": 1, "ipObject": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "ipObjectId": 1, "macObject": { "autoUpdate": true, "createdAt": "example", "description": "example", "entries": [ { "createdAt": "example", "id": 1, "objectId": 1, "updatedAt": "example", "value": "example" } ], "id": 1, "isUsed": true, "isUsedBy": "example", "lastRefreshAt": "example", "lastRefreshError": "example", "name": "example", "refreshIntervalSeconds": 1, "resolutionChecksum": "example", "resolutions": [ { "createdAt": "example", "id": 1, "objectId": 1, "resolvedIp": "example", "resolvedValue": "example", "updatedAt": "example" } ], "sourceChecksum": "example", "type": "example", "updatedAt": "example" }, "macObjectId": 1, "updatedAt": "example" } ], "file": [ { "clientId": "example", "duid": "example", "expiry": 1, "hostname": "example", "iaid": "example", "ip": "example", "mac": "example" } ] }, "error": "example", "message": "example", "status": "example"}Unauthorized
Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{ "data": "example", "error": "example", "message": "example", "status": "example"}Internal Server Error
Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{ "data": "example", "error": "example", "message": "example", "status": "example"}