From 3f4e0086ecfc519e3c29eeb83a189b1b19b29061 Mon Sep 17 00:00:00 2001 From: Shreyas Zare Date: Sat, 30 Apr 2022 13:07:55 +0530 Subject: [PATCH] updated api docs. --- APIDOCS.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/APIDOCS.md b/APIDOCS.md index 64d14e2a..20a12407 100644 --- a/APIDOCS.md +++ b/APIDOCS.md @@ -49,7 +49,7 @@ These API calls allow to login or logout using credentials. Once logged in, a se ### Login -This call authenticates with the server and generates a session token to be used for subsequent API calls. +This call authenticates with the server and generates a session token to be used for subsequent API calls. The session token expires in 30 minutes from the last API call. URL: `http://localhost:5380/api/login?user=admin&pass=admin` @@ -3677,6 +3677,7 @@ RESPONSE: "scope": "Default", "type": "Reserved", "hardwareAddress": "00-00-00-00-00-00", + "clientIdentifier": "1-000000000000", "address": "192.168.1.5", "hostName": "server1.local", "leaseObtained": "08/25/2020 17:52:51", @@ -3686,6 +3687,7 @@ RESPONSE: "scope": "Default", "type": "Dynamic", "hardwareAddress": "00-00-00-00-00-00", + "clientIdentifier": "1-000000000000", "address": "192.168.1.13", "hostName": null, "leaseObtained": "06/15/2020 16:41:46", @@ -3695,6 +3697,7 @@ RESPONSE: "scope": "Default", "type": "Dynamic", "hardwareAddress": "00-00-00-00-00-00", + "clientIdentifier": "1-000000000000", "address": "192.168.1.15", "hostName": "desktop-ea2miaf.local", "leaseObtained": "06/18/2020 12:19:03", @@ -3893,7 +3896,8 @@ URL: WHERE: - `token`: The session token generated by the `login` call. - `name`: The name of the DHCP scope. -- `hardwareAddress`: The MAC address of the device bearing the dynamic/reserved lease. +- `clientIdentifier` (optional): The client identifier for the lease. Either `hardwareAddress` or `clientIdentifier` must be specified. +- `hardwareAddress` (optional): The MAC address of the device bearing the dynamic/reserved lease. Either `hardwareAddress` or `clientIdentifier` must be specified. RESPONSE: ``` @@ -3913,7 +3917,8 @@ URL: WHERE: - `token`: The session token generated by the `login` call. - `name`: The name of the DHCP scope. -- `hardwareAddress`: The MAC address of the device bearing the dynamic lease. +- `clientIdentifier` (optional): The client identifier for the lease. Either `hardwareAddress` or `clientIdentifier` must be specified. +- `hardwareAddress` (optional): The MAC address of the device bearing the dynamic lease. Either `hardwareAddress` or `clientIdentifier` must be specified. RESPONSE: ``` @@ -3933,7 +3938,8 @@ URL: WHERE: - `token`: The session token generated by the `login` call. - `name`: The name of the DHCP scope. -- `hardwareAddress`: The MAC address of the device bearing the reserved lease. +- `clientIdentifier` (optional): The client identifier for the lease. Either `hardwareAddress` or `clientIdentifier` must be specified. +- `hardwareAddress` (optional): The MAC address of the device bearing the reserved lease. Either `hardwareAddress` or `clientIdentifier` must be specified. RESPONSE: ```