Viewing a DHCP pool group

GET api/admin/v1/dhcp-subnet-groups/{group}

Method parameters

int group, unique identifier of the DHCP group

200 OK

Successful response

JSON

{
    "id": 64,
    "title": "Group",
    "users": [
        {
            "id": 1,
            "name": "admin",
            "login": "admin@mail.com",
            "created_at": "2021-05-27 15:43:37",
            "updated_at": "2022-05-06 14:19:13",
            "expired_at": null,
            "is_licence_limit_reached": false,
            "ptz_priority": 10,
            "access_token_id": null
        }
    ]
}

400 Bad Request

This error indicates that DHCP groups are currently unavailable due to the absence of configured DHCP settings.

401 Unauthorized

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domainapi/admin/v1/dhcp-subnet-groups/{group}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "group": 0
}'

PHP

$data = array (
  'group' => 0,
);
$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-domainapi/admin/v1/dhcp-subnet-groups/{group}', false, $context);