fergalmoran/DnsServer
1
0
Fork 0
mirror of https://github.com/fergalmoran/DnsServer.git synced 2025-12-22 09:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated api docs.

Browse Source
This commit is contained in:
Shreyas Zare
2022-04-30 13:07:55 +05:30
parent daf69eff61
commit 3f4e0086ec
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
APIDOCS.md
View File

@@ -49,7 +49,7 @@ These API calls allow to login or logout using credentials. Once logged in, a se
### Login ### 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: URL:
`http://localhost:5380/api/login?user=admin&pass=admin` `http://localhost:5380/api/login?user=admin&pass=admin`
@@ -3677,6 +3677,7 @@ RESPONSE:
"scope": "Default", "scope": "Default",
"type": "Reserved", "type": "Reserved",
"hardwareAddress": "00-00-00-00-00-00", "hardwareAddress": "00-00-00-00-00-00",
"clientIdentifier": "1-000000000000",
"address": "192.168.1.5", "address": "192.168.1.5",
"hostName": "server1.local", "hostName": "server1.local",
"leaseObtained": "08/25/2020 17:52:51", "leaseObtained": "08/25/2020 17:52:51",
@@ -3686,6 +3687,7 @@ RESPONSE:
"scope": "Default", "scope": "Default",
"type": "Dynamic", "type": "Dynamic",
"hardwareAddress": "00-00-00-00-00-00", "hardwareAddress": "00-00-00-00-00-00",
"clientIdentifier": "1-000000000000",
"address": "192.168.1.13", "address": "192.168.1.13",
"hostName": null, "hostName": null,
"leaseObtained": "06/15/2020 16:41:46", "leaseObtained": "06/15/2020 16:41:46",
@@ -3695,6 +3697,7 @@ RESPONSE:
"scope": "Default", "scope": "Default",
"type": "Dynamic", "type": "Dynamic",
"hardwareAddress": "00-00-00-00-00-00", "hardwareAddress": "00-00-00-00-00-00",
"clientIdentifier": "1-000000000000",
"address": "192.168.1.15", "address": "192.168.1.15",
"hostName": "desktop-ea2miaf.local", "hostName": "desktop-ea2miaf.local",
"leaseObtained": "06/18/2020 12:19:03", "leaseObtained": "06/18/2020 12:19:03",
@@ -3893,7 +3896,8 @@ URL:
WHERE: WHERE:
- `token`: The session token generated by the `login` call. - `token`: The session token generated by the `login` call.
- `name`: The name of the DHCP scope. - `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: RESPONSE:
``` ```
@@ -3913,7 +3917,8 @@ URL:
WHERE: WHERE:
- `token`: The session token generated by the `login` call. - `token`: The session token generated by the `login` call.
- `name`: The name of the DHCP scope. - `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: RESPONSE:
``` ```
@@ -3933,7 +3938,8 @@ URL:
WHERE: WHERE:
- `token`: The session token generated by the `login` call. - `token`: The session token generated by the `login` call.
- `name`: The name of the DHCP scope. - `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: RESPONSE:
``` ```