Show DHCP Leases.

GET

/api/operate/namespaces/{namespace}/sites/{site}/ver/dhcp_leases

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/dhcp_leases \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GET DHCP lease information.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for which the request is sent (system)

site

required

string

Site Name Name of the site.

Responses

200

A successful response.

Media typeapplication/json

DHCP Leases

Active list of DHCP leases that have been leased by VER DHCP server.

object

lease_info

Lease Info

DHCP lease information.

Array<object>

DHCP Lease Information

Information about DHCP lease given by VER DHCP server.

object

client_id

Client Identifier

Client identifier of the client.

string

<= 1024 characters

description

Description

Client Description.

string

>= 21 characters <= 1024 characters

expiry

Expiry

Lease expiry timestamp.

string format: date-time

<= 1024 characters

hostname

Host Name

Host name of the client.

string

<= 1024 characters

interface

Interface

Name of the ver interface to which the client is connected.

string

<= 1024 characters

ip

IP

IP address leased to the client.

string

<= 1024 characters

issue_time

Issue Time

Lease issue timestamp.

string format: date-time

<= 1024 characters

mac

Mac

MAC address of the client.

string

<= 1024 characters

options

Options

DHCP option information.

Array<object>

DHCP Option information

DHCP Option information as a (key, value) pair.

object

key

Key

Option key.

string

>= 7 characters <= 1024 characters

value

Value

Option value.

string

>= 3 characters <= 1024 characters

subnet

Subnet

Subnet of the client.

string

<= 1024 characters

subnet_info

Subnet Info

DHCP information per subnet.

Array<object>

DHCP Subnet Information

Information about DHCP subnet.

object

address_count

Address Count

Number of addresses in the subnet that DHCP can lease.

integer format: int64

free_address_count

Free Addresses

Number of addresses in the subnet that are free (not allocated)

integer format: int64

interface

Interface

Name of the ver interface to which the subnet is assigned.

string

<= 1024 characters

subnet

Subnet

Subnet address.

string

<= 1024 characters

Example^generated

{
  "lease_info": [
    {
      "client_id": "example",
      "description": "example",
      "expiry": "2026-04-15T12:00:00Z",
      "hostname": "example",
      "interface": "example",
      "ip": "example",
      "issue_time": "2026-04-15T12:00:00Z",
      "mac": "example",
      "options": [
        {
          "key": "example",
          "value": "example"
        }
      ],
      "subnet": "example"
    }
  ],
  "subnet_info": [
    {
      "address_count": 1,
      "free_address_count": 1,
      "interface": "example",
      "subnet": "example"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example