Policy > Networking > IP Management > DHCP > DHCP Server Configs

Read DHCP server leases

Read DHCP server leases

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/dhcp-server-configs/{config-id}/leases
/policy/api/v1/global-infra/dhcp-server-configs/{config-id}/leases
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/leases
Request Headers:
n/a
Query Parameters:
DhcpServerLeaseRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/dhcp-server-configs/default/leases?segment_path=/infra/segments/web&connectivity_path=/infra/tier-1s/it_t1&enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
DhcpLeasesResult+

Example Response:

{ "leases" : [ { "subnet" : "184.168.1.0", "start_time" : "2017-06-26 18:34:34 +0000", "mac_address" : "00:50:56:ae:6b:01", "lease_time" : "3600", "expire_time" : "2017-06-26 19:34:35 +0000", "ip_address" : "184.168.1.3" } ], "dhcp_server_id" : "9f34f749-08d9-4744-b1e9-9f079f9ce726", "timestamp" : 1498503052577 }

Required Permissions:

read

Feature:

policy_dhcp

Additional Errors: