Skip to main content
Skip table of contents

List of reservations

List of reservations

Returns a list of DHCP reservations from the database

GET /api/admin/v1/dhcp-reservations

Method parameters

int per_page, the number of items per pagination page. Default is 25


int page, the page number of pagination


mac mac, MAC address


ipv4 ip, IP address

200 OK

Successful response

JSON
{
    "data": [],
    "links": {
        "first": "https://vms.local/api/admin/v1/dhcp-reservations?per_page=25&page=1",
        "last": "https://vms.local/api/admin/v1/dhcp-reservations?per_page=25&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/admin/v1/dhcp-reservations?per_page=25&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/admin/v1/dhcp-reservations",
        "per_page": 25,
        "to": null,
        "total": 0
    }
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/dhcp-reservations' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "mac": "mac",
    "ip": "ipv4"
}'
PHP
PHP
$data = array (
  'per_page' => 0,
  'page' => 0,
  'mac' => 'mac',
  'ip' => 'ipv4',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/dhcp-reservations', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.