fergalmoran/DnsServer
1
0
Fork 0
mirror of https://github.com/fergalmoran/DnsServer.git synced 2026-02-20 14:54:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated api docs

Browse Source
This commit is contained in:
Shreyas Zare
2021-08-14 11:50:57 +05:30
parent ddd52cf2b4
commit 975cde3c0c
1 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
APIDOCS.md
View File

@@ -146,7 +146,7 @@ RESPONSE:
```
{
"response": {
"version": "6.3",
"version": "6.4",
"dnsServerDomain": "server1",
"dnsServerLocalEndPoints": [
"0.0.0.0:53",
@@ -170,7 +170,8 @@ RESPONSE:
"tsigKeys": [
{
"keyName": "key.example.com",
"sharedSecret": "AQ=="
"sharedSecret": "AQ==",
"algorithmName": "hmac-sha256"
}
],
"preferIPv6": false,
@@ -258,7 +259,7 @@ WHERE:
- `enableDnsOverHttps` (optional): Enable this option to accept DNS-over-HTTPS requests for both wire and json response formats.
- `dnsTlsCertificatePath` (optional): Specify a PKCS #12 certificate (.pfx) file path on the server. The certificate must contain private key. This certificate is used by the DNS-over-TLS and DNS-over-HTTPS optional protocols.
- `dnsTlsCertificatePassword` (optional): Enter the certificate (.pfx) password, if any.
- `tsigKeys` (optional): A pipe `|` separated list of TSIG keys names and shared secrets. Set this parameter to `false` to remove all existing keys.
- `tsigKeys` (optional): A pipe `|` separated multi row list of TSIG key name, shared secret, and algorithm. Set this parameter to `false` to remove all existing keys. Supported algorithms are [`hmac-md5.sig-alg.reg.int`, `hmac-sha1`, `hmac-sha256`, `hmac-sha256-128`, `hmac-sha384`, `hmac-sha384-192`, `hmac-sha512`, `hmac-sha512-256`].
- `preferIPv6` (optional): DNS Server will use IPv6 for querying whenever possible with this option enabled. Default value is `false`.
- `enableLogging` (optional): Enable this option to log error and audit logs into the log file. Default value is `true`.
- `logQueries` (optional): Enable this option to log every query received by this DNS Server and the corresponding response answers into the log file. Default value is `false`.
@@ -1799,8 +1800,6 @@ WHERE:
- `primaryNameServerAddresses` (optional): List of comma separated IP addresses of the primary name server. This optional parameter is used only with Secondary and Stub zones. If this parameter is not used, the DNS server will try to recursively resolve the primary name server addresses automatically.
- `zoneTransferProtocol` (optional): The zone transfer protocol to be used by secondary zones. Valid values are [`tcp`, `tls`].
- `tsigKeyName` (optional): The TSIG key name to be used by secondary zones.
- `tsigSharedSecret` (optional): The TSIG shared secret to be used by secondary zones.
- `tsigAlgorithm` (optional): The TSIG algorithm to be used by secondary zones.
- `protocol` (optional): The DNS transport protocol to be used by the conditional forwarder zone. This optional parameter is used with Conditional Forwarder zones. Valid values are [`Udp`, `Tcp`, `Tls`, `Https`]. Default UDP protocol is used when this parameter is missing.
- `forwarder` (optional): The address of the DNS server to be used as a forwarder. This optional parameter is requred to be used with Conditional Forwarder zones. A special value `this-server` can be used as a forwarder which when used will forward all the requests internally to this DNS server such that you can override the zone with records and rest of the zone gets resolved via This Server.
@@ -2125,8 +2124,6 @@ WHERE:
- `primaryAddresses` (optional): This is a comma separated list of IP addresses of the primary name server. This parameter is to be used with secondary and stub zones where the primary name server address is not directly resolveable.
- `zoneTransferProtocol` (optional): The zone transfer protocol to be used by the secondary zone. Valid values are [`tcp`, `tls`].
- `tsigKeyName` (optional): The TSIG key name to be used by the secondary zone.
- `tsigSharedSecret` (optional): The TSIG shared secret to be used by the secondary zone.
- `tsigAlgorithm` (optional): The TSIG algorithm to be used by the secondary zone.
- `port` (optional): This is the port parameter in the SRV record. This parameter is required when updating the SRV record.
- `priority` (optional): This is the priority parameter in the SRV record. This parameter is required when updating the SRV record.
- `weight` (optional): This is the weight parameter in the SRV record. This parameter is required when updating the SRV record.