mirror of
https://github.com/fergalmoran/DnsServer.git
synced 2025-12-22 09:29:50 +00:00
Merge branch 'develop' of https://github.com/TechnitiumSoftware/DnsServer into develop
This commit is contained in:
24
APIDOCS.md
24
APIDOCS.md
@@ -203,6 +203,7 @@ RESPONSE:
|
||||
"qpmLimitIPv6PrefixLength": 56,
|
||||
"serveStale": true,
|
||||
"serveStaleTtl": 259200,
|
||||
"temporaryDisableBlockingTill": "2021-10-10T01:14:27.1106773Z",
|
||||
"cacheMinimumRecordTtl": 10,
|
||||
"cacheMaximumRecordTtl": 86400,
|
||||
"cacheNegativeRecordTtl": 300,
|
||||
@@ -289,6 +290,7 @@ WHERE:
|
||||
- `qpmLimitIPv6PrefixLength` (optional): Sets the client subnet IPv6 prefix length used to define the subnet. Default value is `56`.
|
||||
- `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`.
|
||||
- `temporaryDisableBlockingTill` (read only): An ISO 8601 String with the Date and Time when the Temporary Blocking will end.
|
||||
- `cacheMinimumRecordTtl` (optional): The minimum TTL value that a record can have in cache. Set a value to make sure that the records with TTL value than it stays in cache for a minimum duration. Default value is `10`.
|
||||
- `cacheMaximumRecordTtl` (optional): The maximum TTL value that a record can have in cache. Set a lower value to allow the records to expire early. Default value is `86400`.
|
||||
- `cacheNegativeRecordTtl` (optional): The negative TTL value to use when there is no SOA MINIMUM value available. Default value is `300`.
|
||||
@@ -308,6 +310,7 @@ WHERE:
|
||||
- `enableBlocking` (optional): Sets the DNS server to block domain names using Blocked Zone and Block List Zone.
|
||||
- `allowTxtBlockingReport` (optional): Specifies if the DNS Server should respond with TXT records containing a blocked domain report for TXT type requests.
|
||||
- `blockingType` (optional): Sets how the DNS server should respond to a blocked domain request. Valid values are [`AnyAddress`, `NxDomain`, `CustomAddress`] where `AnyAddress` is default which response with `0.0.0.0` and `::` IP addresses for blocked domains. Using `NxDomain` will respond with `NX Domain` response. `CustomAddress` will return the specified custom blocking addresses.
|
||||
- `blockListNextUpdatedOn` (read only): An ISO 8601 String with the Date and Time when the blocklist will next be updated.
|
||||
- `customBlockingAddresses` (optional): Set the custom blocking addresses to be used for blocked domain response. These addresses are returned only when `blockingType` is set to `CustomAddress`.
|
||||
- `blockListUrls` (optional): A comma separated list of block list URLs that this server must automatically download and use with the block lists zone. DNS Server will use the data returned by the block list URLs to update the block list zone automatically every 24 hours. The expected file format is standard hosts file format or plain text file containing list of domains to block. Set this parameter to `false` to remove existing values.
|
||||
- `blockListUpdateIntervalHours` (optional): The interval in hours to automatically download and update the block lists. Default value is `24`.
|
||||
@@ -332,6 +335,27 @@ RESPONSE:
|
||||
}
|
||||
```
|
||||
|
||||
### Temporarily Disable Block Lists
|
||||
|
||||
This call temporarily disables the block lists and block list zones.
|
||||
|
||||
URL:
|
||||
`http://localhost:5380/api/temporaryDisableBlocking?token=x&minutes=5`
|
||||
|
||||
WHERE:
|
||||
- `token`: The session token generated by the `login` call.
|
||||
- `minutes`: The time in minutes to disable the blocklist for.
|
||||
|
||||
RESPONSE:
|
||||
```
|
||||
{
|
||||
"status": "ok",
|
||||
"response": {
|
||||
"temporaryDisableBlockingTill": "2021-10-10T01:14:27.1106773Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Backup Settings
|
||||
|
||||
This call returns a zip file containing copies of all the items that were requested to be backed up.
|
||||
|
||||
Reference in New Issue
Block a user