diff --git a/APIDOCS.md b/APIDOCS.md index 0b79b062..171c5bce 100644 --- a/APIDOCS.md +++ b/APIDOCS.md @@ -51,13 +51,13 @@ These API calls allow to a user to login, logout, perform account management, et This call authenticates with the server and generates a session token to be used for subsequent API calls. The session token expires as per the user's session expiry timeout value (default 30 minutes) from the last API call. -URL: +URL:\ `http://localhost:5380/api/user/login?user=admin&pass=admin&includeInfo=true` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/login` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -146,10 +146,10 @@ WHERE: Allows creating a non-expiring API token that can be used with automation scripts to make API calls. The token allows access to API calls with the same privileges as that of the user account. Thus its recommended to create a separate user account with limited permissions as required by the specific task that the token will be used for. The token cannot be used to change the user's password, or update the user profile details. -URL: +URL:\ `http://localhost:5380/api/user/createToken?user=admin&pass=admin&tokenName=MyToken1&includeInfo=true` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -174,13 +174,13 @@ WHERE: This call ends the session generated by the `login` or the `createToken` call. The `token` would no longer be valid after calling the `logout` API. -URL: +URL:\ `http://localhost:5380/api/user/logout?token=932b2a3495852c15af01598f62563ae534460388b6a370bfbbb8bb6094b698e9` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/logout` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -197,10 +197,10 @@ RESPONSE: Returns the same info as that of the `login` or the `createToken` calls for the session specified by the token. -URL: +URL:\ `http://localhost:5380/api/user/session/get?token=932b2a3495852c15af01598f62563ae534460388b6a370bfbbb8bb6094b698e9` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -282,10 +282,10 @@ RESPONSE: Allows deleting a session for the current user. -URL: +URL:\ `http://localhost:5380/api/user/session/delete?token=x&partialToken=620c3bfcd09d0a07` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -306,13 +306,13 @@ Allows changing the password for the current logged in user account. NOTE: It is highly recommended to change the `admin` user password on first use to avoid security related issues. -URL: +URL:\ `http://localhost:5380/api/user/changePassword?token=x&pass=password` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/changePassword` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -330,10 +330,10 @@ RESPONSE: Gets the user account profile details. -URL: +URL:\ `http://localhost:5380/api/user/profile/get?token=x` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -375,10 +375,10 @@ RESPONSE: Allows changing user account profile values. -URL: +URL:\ `http://localhost:5380/api/user/profile/set?token=x&displayName=Administrator&sessionTimeoutSeconds=1800` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -422,13 +422,13 @@ RESPONSE: This call requests the server to check for software update. -URL: +URL:\ `http://localhost:5380/api/user/checkForUpdate?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/checkForUpdate` -PERMISSIONS: +PERMISSIONS:\ None WHERE: @@ -459,13 +459,13 @@ These API calls provide access to dashboard stats and allow deleting stat files. Returns the DNS stats that are displayed on the web console dashboard. -URL: +URL:\ `http://localhost:5380/api/dashboard/stats/get?token=x&type=lastHour` -OBSOLETE PATH: +OBSOLETE PATH:\ `api/getStats` -PERMISSIONS: +PERMISSIONS:\ Dashboard: View WHERE: @@ -1436,13 +1436,13 @@ RESPONSE: Returns the top stats data for specified stats type. -URL: +URL:\ `http://localhost:5380/api/dashboard/stats/getTop?token=x&type=lastHour&statsType=TopClients&limit=1000` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/getTopStats` -PERMISSIONS: +PERMISSIONS:\ Dashboard: View WHERE: @@ -1509,13 +1509,13 @@ The response json will include the object with definition same in the `getStats` Permanently delete all hourly and daily stats files from the disk and clears all stats stored in memory. This call will clear all stats from the Dashboard. -URL: +URL:\ `http://localhost:5380/api/dashboard/stats/deleteAll?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteAllStats` -PERMISSIONS: +PERMISSIONS:\ Dashboard: Delete WHERE: @@ -1537,14 +1537,14 @@ These API calls allow managing all hosted zones on the DNS server. List all authoritative zones hosted on this DNS server. The list contains only the zones that the user has View permissions for. These API calls requires permission for both the Zones section as well as the individual permission for each zone. -URL: +URL:\ `http://localhost:5380/api/zones/list?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/list` `/api/listZones` -PERMISSIONS: +PERMISSIONS:\ Zones: View Zone: View @@ -1618,14 +1618,14 @@ RESPONSE: Creates a new authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/create?token=x&zone=example.com&type=Primary` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/create` `/api/createZone` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify WHERE: @@ -1661,14 +1661,14 @@ WHERE: Enables an authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/enable?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/enable` `/api/enableZone` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Modify @@ -1687,14 +1687,14 @@ RESPONSE: Disables an authoritative zone. This will prevent the DNS server from responding for queries to this zone. -URL: +URL:\ `http://localhost:5380/api/zones/disable?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/disable` `/api/disableZone` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Modify @@ -1713,14 +1713,14 @@ RESPONSE: Deletes an authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/delete?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/delete` `/api/deleteZone` -PERMISSIONS: +PERMISSIONS:\ Zones: Delete Zone: Delete @@ -1739,13 +1739,13 @@ RESPONSE: Allows resyncing a Secondary or Stub zone. This process will re-fetch all the records from the primary name server for the zone. -URL: +URL:\ `http://localhost:5380/api/zones/resync?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/resync` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Modify @@ -1764,13 +1764,13 @@ RESPONSE: Gets the zone specific options. -URL: +URL:\ `http://localhost:5380/api/zones/options/get?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/options` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: View @@ -1805,13 +1805,13 @@ RESPONSE: Sets the zone specific options. -URL: +URL:\ `http://localhost:5380/api/zones/options/set?token=x&zone=example.com&disabled=false&zoneTransfer=Allow&zoneTransferNameServers=¬ify=ZoneNameServers¬ifyNameServers=` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/options` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -1836,10 +1836,10 @@ RESPONSE: Gets the zone specific permissions. -URL: +URL:\ `http://localhost:5380/api/zones/permissions/get?token=x&zone=example.com&includeUsersAndGroups=true` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: View @@ -1895,10 +1895,10 @@ RESPONSE: Sets the zone specific permissions. -URL: +URL:\ `http://localhost:5380/api/zones/permissions/set?token=x&zone=example.com&userPermissions=admin|true|true|true&groupPermissions=Administrators|true|true|true|DNS%20Administrators|true|true|true` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -1945,10 +1945,10 @@ RESPONSE: Signs the primary zone (DNSSEC). -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/sign?token=x&zone=example.com&algorithm=ECDSA&dnsKeyTtl=86400&zskRolloverDays=90&nxProof=NSEC3&iterations=0&saltLength=0&curve=P256` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/sign` PERMISSONS: @@ -1980,13 +1980,13 @@ RESPONSE: Unsigns the primary zone (DNSSEC). -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/unsign?token=x&zone=example.com -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/unsign` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2005,13 +2005,13 @@ RESPONSE: Get the DNSSEC properties for the primary zone. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/get?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/getProperties` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: View @@ -2058,13 +2058,13 @@ RESPONSE: Converts a primary zone from NSEC3 to NSEC for proof of non-existence. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/convertToNSEC?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/convertToNSEC` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2083,13 +2083,13 @@ RESPONSE: Converts a primary zone from NSEC to NSEC3 for proof of non-existence. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/convertToNSEC3?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/convertToNSEC3` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2108,13 +2108,13 @@ RESPONSE: Updates the iteration and salt length parameters for NSEC3. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/updateNSEC3Params?token=x&zone=example.com&iterations=0&saltLength=0` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/updateNSEC3Params` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2135,13 +2135,13 @@ RESPONSE: Updates the TTL value for DNSKEY resource record set. The value can be updated only when all the DNSKEYs are in ready or active state. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/updateDnsKeyTtl?token=x&zone=example.com&ttl=86400` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/updateDnsKeyTtl` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2161,13 +2161,13 @@ RESPONSE: Generates a private key to be used for signing the zone with DNSSEC. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/generatePrivateKey?token=x&zone=example.com&keyType=KeySigningKey&algorithm=ECDSA&curve=P256` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/generatePrivateKey` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2192,13 +2192,13 @@ RESPONSE: Updates the DNSSEC private key properties. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/updatePrivateKey?token=x&zone=example.com&keyTag=1234&rolloverDays=90` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/updatePrivateKey` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2219,13 +2219,13 @@ RESPONSE: Deletes a private key that has state set as `Generated`. Private keys with any other state cannot be delete. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/deletePrivateKey?token=x&zone=example.com&keyTag=12345` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/deletePrivateKey` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2245,13 +2245,13 @@ RESPONSE: Publishes all private keys that have state set as `Generated` by adding associated DNSKEY records for them. Once published, the keys will be automatically activated. For Key Signing Keys (KSK), once the state is set to `Ready` you can then safely replace the old DS record from the parent zone with a new DS key record for the KSK associated DNSKEY record. Once the new DS record is published at the parent zone, the DNS server will automatically detect and set the KSK state to `Active`. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/publishAllPrivateKeys?token=x&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/publishAllPrivateKeys` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2270,13 +2270,13 @@ RESPONSE: Generates and publishes a new private key for the given key that has to be rolled over. The old private key and its associated DNSKEY record will be automatically retired and removed safely once the new key is active. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/rolloverDnsKey?token=x&zone=example.com&keyTag=12345` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/rolloverDnsKey` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2296,13 +2296,13 @@ RESPONSE: Retires the specified private key and its associated DNSKEY record and removes it safely. To retire an existing DNSKEY, there must be at least one active key available. -URL: +URL:\ `http://localhost:5380/api/zones/dnssec/properties/retireDnsKey?token=x&zone=example.com&keyTag=12345` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/dnssec/retireDnsKey` -PERMISSIONS: +PERMISSIONS:\ Zones: Modify Zone: Delete @@ -2322,14 +2322,14 @@ RESPONSE: Adds an resource record for an authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/records/add?token=x&domain=example.com&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/addRecord` `/api/addRecord` -PERMISSIONS: +PERMISSIONS:\ Zones: None Zone: Modify @@ -2406,14 +2406,14 @@ RESPONSE: Gets all records for a given authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/records/get?token=x&domain=example.com&zone=example.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/getRecords` `/api/getRecords` -PERMISSIONS: +PERMISSIONS:\ Zones: None Zone: View @@ -2949,14 +2949,14 @@ RESPONSE: Updates an existing record in an authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/records/update?token=x&domain=mail.example.com&zone=example.com&type=A&value=127.0.0.1&newValue=127.0.0.2&ptr=false` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/updateRecord` `/api/updateRecord` -PERMISSIONS: +PERMISSIONS:\ Zones: None Zone: Modify @@ -3070,14 +3070,14 @@ RESPONSE: Deletes a record from an authoritative zone. -URL: +URL:\ `http://localhost:5380/api/zones/records/delete?token=x&domain=example.com&zone=example.com&type=A&value=127.0.0.1` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/zone/deleteRecord` `/api/deleteRecord` -PERMISSIONS: +PERMISSIONS:\ Zones: None Zone: Delete @@ -3123,13 +3123,13 @@ These API calls allow managing the DNS server cache. List all cached zones. -URL: +URL:\ `http://localhost:5380/api/cache/list?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/listCachedZones` -PERMISSIONS: +PERMISSIONS:\ Cache: View WHERE: @@ -3162,13 +3162,13 @@ RESPONSE: Deletes a specific zone from the DNS cache. -URL: +URL:\ `http://localhost:5380/api/cache/delete?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteCachedZone` -PERMISSIONS: +PERMISSIONS:\ Cache: Delete WHERE: @@ -3186,13 +3186,13 @@ RESPONSE: This call clears all the DNS cache from the server forcing the DNS server to make recursive queries again to populate the cache. -URL: +URL:\ `http://localhost:5380/api/cache/flush?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/flushDnsCache` -PERMISSIONS: +PERMISSIONS:\ Cache: Delete WHERE: @@ -3213,13 +3213,13 @@ These API calls allow managing the Allowed zones. List all allowed zones. -URL: +URL:\ `http://localhost:5380/api/allowed/list?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/listAllowedZones` -PERMISSIONS: +PERMISSIONS:\ Allowed: View WHERE: @@ -3266,13 +3266,13 @@ RESPONSE: Adds a domain name into the Allowed Zones. -URL: +URL:\ `http://localhost:5380/api/allowed/add?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/allowZone` -PERMISSIONS: +PERMISSIONS:\ Allowed: Modify WHERE: @@ -3290,13 +3290,13 @@ RESPONSE: Allows deleting a zone from the Allowed Zones. -URL: +URL:\ `http://localhost:5380/api/allowed/delete?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteAllowedZone` -PERMISSIONS: +PERMISSIONS:\ Allowed: Delete WHERE: @@ -3314,13 +3314,13 @@ RESPONSE: Flushes the Allowed zone to clear all records. -URL: +URL:\ `http://localhost:5380/api/allowed/flush?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/flushAllowedZone` -PERMISSIONS: +PERMISSIONS:\ Allowed: Delete WHERE: @@ -3337,13 +3337,13 @@ RESPONSE: Imports domain names into the Allowed Zones. -URL: +URL:\ `http://localhost:5380/api/allowed/import?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/importAllowedZones` -PERMISSIONS: +PERMISSIONS:\ Allowed: Modify WHERE: @@ -3370,13 +3370,13 @@ RESPONSE: Allows exporting all the zones from the Allowed Zones as a text file. -URL: +URL:\ `http://localhost:5380/api/allowed/export?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/exportAllowedZones` -PERMISSIONS: +PERMISSIONS:\ Allowed: View WHERE: @@ -3393,13 +3393,13 @@ These API calls allow managing the Blocked zones. List all blocked zones. -URL: +URL:\ `http://localhost:5380/api/blocked/list?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/listBlockedZones` -PERMISSIONS: +PERMISSIONS:\ Blocked: View WHERE: @@ -3446,13 +3446,13 @@ RESPONSE: Adds a domain name into the Blocked Zones. -URL: +URL:\ `http://localhost:5380/api/blocked/add?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/blockZone` -PERMISSIONS: +PERMISSIONS:\ Blocked: Modify WHERE: @@ -3470,13 +3470,13 @@ RESPONSE: Allows deleting a zone from the Blocked Zones. -URL: +URL:\ `http://localhost:5380/api/blocked/delete?token=x&domain=google.com` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteBlockedZone` -PERMISSIONS: +PERMISSIONS:\ Blocked: Delete WHERE: @@ -3494,13 +3494,13 @@ RESPONSE: Flushes the Blocked zone to clear all records. -URL: +URL:\ `http://localhost:5380/api/blocked/flush?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/flushBlockedZone` -PERMISSIONS: +PERMISSIONS:\ Blocked: Delete WHERE: @@ -3517,13 +3517,13 @@ RESPONSE: Imports domain names into Blocked Zones. -URL: +URL:\ `http://localhost:5380/api/blocked/import?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/importBlockedZones` -PERMISSIONS: +PERMISSIONS:\ Blocked: Modify WHERE: @@ -3550,13 +3550,13 @@ RESPONSE: Allows exporting all the zones from the Blocked Zones as a text file. -URL: +URL:\ `http://localhost:5380/api/blocked/export?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/exportBlockedZones` -PERMISSIONS: +PERMISSIONS:\ Blocked: View WHERE: @@ -3573,10 +3573,10 @@ These API calls allows managing DNS Apps. Lists all installed apps on the DNS server. If the DNS server has Internet access and is able to retrieve data from DNS App Store, the API call will also return if a store App has updates available. -URL: +URL:\ `http://localhost:5380/api/apps/list?token=x` -PERMISSIONS: +PERMISSIONS:\ Apps/Zones/Logs: View WHERE: @@ -3626,10 +3626,10 @@ RESPONSE: Lists all available apps on the DNS App Store. -URL: +URL:\ `http://localhost:5380/api/apps/listStoreApps?token=x` -PERMISSIONS: +PERMISSIONS:\ Apps: View WHERE: @@ -3694,10 +3694,10 @@ RESPONSE: Download an app zip file from given URL and installs it on the DNS Server. -URL: +URL:\ `http://localhost:5380/api/apps/downloadAndInstall?token=x&name=app-name&url=https://example.com/app.zip` -PERMISSIONS: +PERMISSIONS:\ Apps: Delete WHERE: @@ -3717,10 +3717,10 @@ RESPONSE: Download an app zip file from given URL and updates an existing app installed on the DNS Server. -URL: +URL:\ `http://localhost:5380/api/apps/downloadAndUpdate?token=x&name=app-name&url=https://example.com/app.zip` -PERMISSIONS: +PERMISSIONS:\ Apps: Delete WHERE: @@ -3740,10 +3740,10 @@ RESPONSE: Installs a DNS application on the DNS server. -URL: +URL:\ `http://localhost:5380/api/apps/install?token=x&name=app-name` -PERMISSIONS: +PERMISSIONS:\ Apps: Delete WHERE: @@ -3764,10 +3764,10 @@ RESPONSE: Allows to manually update an installed app using a provided app zip file. -URL: +URL:\ `http://localhost:5380/api/apps/update?token=x&name=app-name` -PERMISSIONS: +PERMISSIONS:\ Apps: Delete WHERE: @@ -3788,10 +3788,10 @@ RESPONSE: Uninstall an app from the DNS server. This does not remove any APP records that were using this DNS application. -URL: +URL:\ `http://localhost:5380/api/apps/uninstall?token=x&name=app-name` -PERMISSIONS: +PERMISSIONS:\ Apps: Delete WHERE: @@ -3810,13 +3810,13 @@ RESPONSE: Retrieve the DNS application config from the `dnsApp.config` file in the application folder. -URL: +URL:\ `http://localhost:5380/api/apps/config/get?token=x&name=app-name` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/apps/getConfig` -PERMISSIONS: +PERMISSIONS:\ Apps: View WHERE: @@ -3837,13 +3837,13 @@ RESPONSE: Saves the provided DNS application config into the `dnsApp.config` file in the application folder. -URL: +URL:\ `http://localhost:5380/api/apps/config/set?token=x&name=app-name` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/apps/setConfig` -PERMISSIONS: +PERMISSIONS:\ Apps: Modify WHERE: @@ -3869,13 +3869,13 @@ These API calls allow interacting with the DNS Client section. ### Resolve Query -URL: +URL:\ `http://localhost:5380/api/dnsClient/resolve?token=x&server=this-server&domain=example.com&type=A&protocol=UDP` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/resolveQuery` -PERMISSIONS: +PERMISSIONS:\ DnsClient: View WHERE: @@ -3948,13 +3948,13 @@ These API calls allow managing the DNS server settings. This call returns all the DNS server settings. -URL: +URL:\ `http://localhost:5380/api/settings/get?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/getDnsSettings` -PERMISSIONS: +PERMISSIONS:\ Settings: View WHERE: @@ -4047,13 +4047,13 @@ RESPONSE: This call allows to change the DNS server settings. -URL: +URL:\ `http://localhost:5380/api/settings/set?token=x&dnsServerDomain=server1&dnsServerLocalEndPoints=0.0.0.0:53,[::]:53&webServiceLocalAddresses=0.0.0.0,[::]&webServiceHttpPort=5380&webServiceEnableTls=false&webServiceTlsPort=53443&webServiceTlsCertificatePath=&webServiceTlsCertificatePassword=&enableDnsOverHttp=false&enableDnsOverTls=false&enableDnsOverHttps=false&dnsTlsCertificatePath=&dnsTlsCertificatePassword=&preferIPv6=false&logQueries=true&allowRecursion=true&allowRecursionOnlyForPrivateNetworks=true&randomizeName=true&cachePrefetchEligibility=2&cachePrefetchTrigger=9&cachePrefetchSampleIntervalInMinutes=5&cachePrefetchSampleEligibilityHitsPerHour=30&proxyType=socks5&proxyAddress=192.168.10.2&proxyPort=9050&proxyUsername=username&proxyPassword=password&proxyBypass=127.0.0.0/8,169.254.0.0/16,fe80::/10,::1,localhost&forwarders=192.168.10.2&forwarderProtocol=Udp&useNxDomainForBlocking=false&blockListUrls=https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts,https://mirror1.malwaredomains.com/files/justdomains,https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt,https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/setDnsSettings` -PERMISSIONS: +PERMISSIONS:\ Settings: Modify WHERE: @@ -4138,13 +4138,13 @@ This call returns the newly updated settings in the same format as that of the ` This call allows to reset the next update schedule and force download and update of the block lists. -URL: +URL:\ `http://localhost:5380/api/settings/forceUpdateBlockLists?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/forceUpdateBlockLists` -PERMISSIONS: +PERMISSIONS:\ Settings: Modify WHERE: @@ -4161,13 +4161,13 @@ RESPONSE: This call temporarily disables the block lists and block list zones. -URL: +URL:\ `http://localhost:5380/api/settings/temporaryDisableBlocking?token=x&minutes=5` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/temporaryDisableBlocking` -PERMISSIONS: +PERMISSIONS:\ Settings: Modify WHERE: @@ -4188,13 +4188,13 @@ RESPONSE: This call returns a zip file containing copies of all the items that were requested to be backed up. -URL: +URL:\ `http://localhost:5380/api/settings/backup?token=x&blockLists=true&logs=true&scopes=true&stats=true&zones=true&allowedZones=true&blockedZones=true&dnsSettings=true&logSettings=true&authConfig=true` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/backupSettings` -PERMISSIONS: +PERMISSIONS:\ Settings: Delete WHERE: @@ -4218,13 +4218,13 @@ A zip file with content type `application/zip` and content disposition set to `a This call restores selected items from a given backup zip file. -URL: +URL:\ `http://localhost:5380/api/settings/restore?token=x&blockLists=true&logs=true&scopes=true&stats=true&zones=true&allowedZones=true&blockedZones=true&dnsSettings=true&logSettings=true&deleteExistingFiles=true&authConfig=true` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/restoreSettings` -PERMISSIONS: +PERMISSIONS:\ Settings: Delete WHERE: @@ -4256,13 +4256,13 @@ Allows managing the built-in DHCP server. Lists all the DHCP leases. -URL: +URL:\ `http://localhost:5380/api/dhcp/leases/list?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/listDhcpLeases` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: View WHERE: @@ -4313,13 +4313,13 @@ RESPONSE: Removes a dynamic or reserved lease allocation. This API must be used carefully to make sure that there is no IP address conflict caused by removing a lease. -URL: +URL:\ `http://localhost:5380/api/dhcp/leases/remove?token=x&name=Default&hardwareAddress=00:00:00:00:00:00` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/removeDhcpLease` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Delete WHERE: @@ -4340,13 +4340,13 @@ RESPONSE: Converts a dynamic lease to reserved lease. -URL: +URL:\ `http://localhost:5380/api/dhcp/leases/convertToReserved?token=x&name=Default&hardwareAddress=00:00:00:00:00:00` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/convertToReservedLease` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4367,13 +4367,13 @@ RESPONSE: Converts a reserved lease to dynamic lease. -URL: +URL:\ `http://localhost:5380/api/dhcp/leases/convertToDynamic?token=x&name=Default&hardwareAddress=00:00:00:00:00:00` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/convertToDynamicLease` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4394,13 +4394,13 @@ RESPONSE: Lists all the DHCP scopes available on the server. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/list?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/listDhcpScopes` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: View WHERE: @@ -4430,13 +4430,13 @@ RESPONSE: Gets the complete details of the scope configuration. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/get?token=x&name=Default` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/getDhcpScope` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: View WHERE: @@ -4511,13 +4511,13 @@ RESPONSE: Sets the DHCP scope configuration. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/set?token=x&name=Default&startingAddress=192.168.1.1&endingAddress=192.168.1.254&subnetMask=255.255.255.0&leaseTimeDays=7&leaseTimeHours=0&leaseTimeMinutes=0&offerDelayTime=0&domainName=local&dnsTtl=900&serverAddress=&serverHostName=&bootFileName=&routerAddress=192.168.1.1&useThisDnsServer=false&dnsServers=192.168.1.5&winsServers=192.168.1.5&ntpServers=192.168.1.5&staticRoutes=172.16.0.0|255.255.255.0|192.168.1.2&exclusions=192.168.1.1|192.168.1.10&reservedLeases=hostname|00-00-00-00-00-00|192.168.1.10|comments&allowOnlyReservedLeases=false` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/setDhcpScope` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4562,10 +4562,10 @@ RESPONSE: Adds a reserved lease entry to the specified scope. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/addReservedLease?token=x` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4588,10 +4588,10 @@ RESPONSE: Removed a reserved lease entry from the specified scope. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/removeReservedLease?token=x` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4611,13 +4611,13 @@ RESPONSE: Enables the DHCP scope allowing the server to allocate leases. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/enable?token=x&name=Default` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/enableDhcpScope` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4636,13 +4636,13 @@ RESPONSE: Disables the DHCP scope and stops any further lease allocations. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/disable?token=x&name=Default` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/disableDhcpScope` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Modify WHERE: @@ -4661,13 +4661,13 @@ RESPONSE: Permanently deletes the DHCP scope from the disk. -URL: +URL:\ `http://localhost:5380/api/dhcp/scopes/delete?token=x&name=Default` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteDhcpScope` -PERMISSIONS: +PERMISSIONS:\ DhcpServer: Delete WHERE: @@ -4690,10 +4690,10 @@ Allows managing the DNS server administration which includes managing all sessio Returns a list of active user sessions. -URL: +URL:\ `http://localhost:5380/api/admin/sessions/list?token=x` -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -4734,10 +4734,10 @@ RESPONSE: Allows creating a non-expiring API token that can be used with automation scripts to make API calls. The token allows access to API calls with the same privileges as that of the user and thus its advised to create a separate user with limited permissions required for creating the API token. The token cannot be used to change the user's password, or update the user profile details. -URL: +URL:\ `http://localhost:5380/api/admin/sessions/createToken?token=x&user=admin&tokenName=MyToken1` -PERMISSIONS: +PERMISSIONS:\ Administration: Modify WHERE: @@ -4761,10 +4761,10 @@ RESPONSE: Deletes a specified user's session. -URL: +URL:\ `http://localhost:5380/api/admin/sessions/delete?token=x&partialToken=ddfaecb8e9325e77` -PERMISSIONS: +PERMISSIONS:\ Administration: Delete WHERE: @@ -4783,10 +4783,10 @@ RESPONSE: Returns a list of all users. -URL: +URL:\ `http://localhost:5380/api/admin/users/list?token=x` -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -4825,10 +4825,10 @@ RESPONSE: Creates a new user account. -URL: +URL:\ `http://localhost:5380/api/admin/users/create?token=x&displayName=User&user=user1&pass=password` -PERMISSIONS: +PERMISSIONS:\ Administration: Modify WHERE: @@ -4857,10 +4857,10 @@ RESPONSE: Returns a user account profile details. -URL: +URL:\ `http://localhost:5380/api/admin/users/get?token=x&user=admin&includeGroups=true -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -4919,10 +4919,10 @@ RESPONSE: Allows changing user account profile details. -URL: +URL:\ `http://localhost:5380/api/admin/users/set?token=x&user=admin&displayName=Administrator&disabled=false&sessionTimeoutSeconds=1800&memberOfGroups=Administrators` -PERMISSIONS: +PERMISSIONS:\ Administration: Modify WHERE: @@ -4982,10 +4982,10 @@ RESPONSE: Deletes a user account. -URL: +URL:\ `http://localhost:5380/api/admin/users/delete?token=x&user=user1` -PERMISSIONS: +PERMISSIONS:\ Administration: Delete WHERE: @@ -5004,10 +5004,10 @@ RESPONSE: Returns a list of all groups. -URL: +URL:\ `http://localhost:5380/api/admin/groups/list?token=x` -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -5040,10 +5040,10 @@ RESPONSE: Creates a new group. -URL: +URL:\ `http://localhost:5380/api/admin/groups/create?token=x&group=Group1&description=My%20description` -PERMISSIONS: +PERMISSIONS:\ Administration: Modify WHERE: @@ -5066,10 +5066,10 @@ RESPONSE: Returns the details for a group. -URL: +URL:\ `http://localhost:5380/api/admin/groups/get?token=x&group=Administrators&includeUsers=true` -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -5099,10 +5099,10 @@ RESPONSE: Allows changing group description or rename a group. -URL: +URL:\ `http://localhost:5380/api/admin/groups/set?token=x&group=Administrators&description=Super%20administrators&members=admin` -PERMISSIONS: +PERMISSIONS:\ Administration: Modify WHERE: @@ -5130,10 +5130,10 @@ RESPONSE: Allows deleting a group. -URL: +URL:\ `http://localhost:5380/api/admin/groups/delete?token=x&group=Group1` -PERMISSIONS: +PERMISSIONS:\ Administration: Delete WHERE: @@ -5150,10 +5150,10 @@ RESPONSE: ### List Permissions -URL: +URL:\ `http://localhost:5380/api/admin/permissions/list?token=x` -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -5432,10 +5432,10 @@ RESPONSE: Gets details of the permissions for the specified section. -URL: +URL:\ `http://localhost:5380/api/admin/permissions/get?token=x§ion=Dashboard&includeUsersAndGroups=true` -PERMISSIONS: +PERMISSIONS:\ Administration: View WHERE: @@ -5489,10 +5489,10 @@ RESPONSE: Allows changing permissions for the specified section. -URL: +URL:\ `http://localhost:5380/api/admin/permissions/set?token=x§ion=Dashboard&userPermissions=shreyas|true|false|false&groupPermissions=Administrators|true|true|true|Everyone|true|false|false` -PERMISSIONS: +PERMISSIONS:\ Administration: Delete WHERE: @@ -5539,13 +5539,13 @@ RESPONSE: Lists all logs files available on the DNS server. -URL: +URL:\ `http://localhost:5380/api/logs/list?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/listLogs` -PERMISSIONS: +PERMISSIONS:\ Logs: View WHERE: @@ -5586,13 +5586,13 @@ RESPONSE: Downloads the log file. -URL: +URL:\ `http://localhost:5380/api/logs/download?token=x&fileName=2020-09-10&limit=2` -OBSOLETE PATH: +OBSOLETE PATH:\ `/log/{fileName}` -PERMISSIONS: +PERMISSIONS:\ Logs: View WHERE: @@ -5610,10 +5610,10 @@ Permanently deletes a log file from the disk. URL: `http://localhost:5380/api/logs/delete?token=x&log=2020-09-19` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteLog` -PERMISSIONS: +PERMISSIONS:\ Logs: Delete WHERE: @@ -5632,13 +5632,13 @@ RESPONSE: Permanently delete all log files from the disk. -URL: +URL:\ `http://localhost:5380/api/logs/deleteAll?token=x` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/deleteAllLogs` -PERMISSIONS: +PERMISSIONS:\ Logs: Delete WHERE: @@ -5656,13 +5656,13 @@ RESPONSE: Queries for logs to a specified DNS app. -URL: +URL:\ `http://localhost:5380/api/logs/query?token=x&name=AppName&classPath=AppClassPath&=pageNumber=1&entriesPerPage=10&descendingOrder=true&start=yyyy-MM-dd HH:mm:ss&end=yyyy-MM-dd HH:mm:ss&clientIpAddress=&protocol=&responseType=&rcode=&qname=&qtype=&qclass=` -OBSOLETE PATH: +OBSOLETE PATH:\ `/api/queryLogs` -PERMISSIONS: +PERMISSIONS:\ Logs: View WHERE: