updated api docs

This commit is contained in:
Shreyas Zare
2021-05-23 19:12:50 +05:30
parent 1d21b31c1d
commit e53fbd1e44

View File

@@ -181,6 +181,9 @@ RESPONSE:
],
"randomizeName": true,
"qnameMinimization": true,
"qpmLimit", 0,
"qpmLimitSampleMinutes": 5,
"qpmLimitSamplingIntervalInMinutes": 1
"serveStale": true,
"serveStaleTtl": 259200,
"cachePrefetchEligibility": 2,
@@ -254,6 +257,9 @@ WHERE:
- `recursionAllowedNetworks` (optional): A comma separated list of network addresses in CIDR format that must be allowed recursion. Set this parameter to `false` to remove existing values. These values are only used when `recursion` is set to `UseSpecifiedNetworks`.
- `randomizeName` (optional): Enables QNAME randomization [draft-vixie-dnsext-dns0x20-00](https://tools.ietf.org/html/draft-vixie-dnsext-dns0x20-00) when using UDP as the transport protocol. Default value is `true`.
- `qnameMinimization` (optional): Enables QNAME minimization [draft-ietf-dnsop-rfc7816bis-04](https://tools.ietf.org/html/draft-ietf-dnsop-rfc7816bis-04) when doing recursive resolution. Default value is `true`.
- `qpmLimit` (optional): Sets the Queries Per Minute (QPM) limit that is enforces per client (IP address). Set value to `0` to disable the feature.
- `qpmLimitSampleMinutes` (optional): Sets the client query stats sample size in minutes for QPM limit feature. Default value is `5`.
- `qpmLimitSamplingIntervalInMinutes` (optional): Sets the client query stats sampling interval in minutes for QPM limit feature. Default value is 1.
- `serveStale` (optional): Enable the serve stale feature to improve resiliency by using expired or stale records in cache when the DNS server is unable to reach the upstream or authoritative name servers. Default value is `true`.
- `serveStaleTtl` (optional): The TTL value in seconds which should be used for cached records that are expired. When the serve stale TTL too expires for a stale record, it gets removed from the cache. Recommended value is between 1-3 days and maximum supported value is 7 days. Default value is `259200`.
- `cachePrefetchEligibility` (optional): The minimum initial TTL value of a record needed to be eligible for prefetching.
@@ -1840,6 +1846,57 @@ RESPONSE:
}
```
### Get Zone Options
Gets the zone specific options.
URL:
`http://localhost:5380/api/zone/options/get?token=x&domain=example.com`
WHERE:
- `token`: The session token generated by the `login` call.
- `domain`: The domain name of the zone to get options.
RESPONSE:
```
{
"response": {
"name": "example.com",
"type": "Primary",
"internal": false,
"disabled": false,
"zoneTransfer": "AllowOnlyZoneNameServers",
"zoneTransferNameServers": [],
"notify": "ZoneNameServers",
"notifyNameServers": []
},
"status": "ok"
}
```
### Set Zone Options
Sets the zone specific options.
URL:
`http://localhost:5380/api/zone/options/set?token=x&domain=example.com&disabled=false&zoneTransfer=Allow&zoneTransferNameServers=&notify=ZoneNameServers&notifyNameServers=`
WHERE:
- `token`: The session token generated by the `login` call.
- `domain`: The domain name of the zone to set options.
- `disabled` (optional): Sets if the zone is enabled or disabled.
- `zoneTransfer` (optional): Sets if the zone allows zone transfer. Valid options are [`Deny`, `Allow`, `AllowOnlyZoneNameServers`, `AllowOnlySpecifiedNameServers`].
- `zoneTransferNameServers` (optional): A list of comma separated IP addreses which should be allowed to perform zone transfer. This list is enabled only when `zoneTransfer` option is set to `AllowOnlySpecifiedNameServers`.
- `notify` (optional): Sets if the DNS server should notify other DNS servers for zone updates. Valid options are [`None`, `ZoneNameServers`, `SpecifiedNameServers`].
- `notifyNameServers` (optional): A list of comma separated IP addreses which should be notified by the DNS server for zone updates. This list is used only when `notify` option is set to `SpecifiedNameServers`.
RESPONSE:
```
{
"status": "ok"
}
```
### Add Record
Adds an resource record for an authoritative zone.
@@ -2074,7 +2131,7 @@ RESPONSE:
{
"name": "Split Horizon",
"version": "1.1",
"details": [
"requestHandlers": [
{
"classPath": "SplitHorizon.SimpleAddress",
"description": "Returns A or AAAA records with different set of IP addresses for clients querying over public and private networks.",
@@ -2093,7 +2150,7 @@ RESPONSE:
"updateVersion": "1.1",
"updateUrl": "https://download.technitium.com/dns/apps/WhatIsMyDnsApp.zip",
"updateAvailable": false,
"details": [
"requestHandlers": [
{
"classPath": "WhatIsMyDns.App",
"description": "Returns the IP address of the user's DNS Server for A, AAAA, and TXT queries.",