updated APIDOCS.

This commit is contained in:
Shreyas Zare
2026-10-03 14:20:59 +05:30
parent 4235c974d8
commit 736bd562be
+18 -14
View File
@@ -416,7 +416,7 @@ WHERE:
- `pass`: The current password for the currently logged in user.
- `newPass`: The new password to be set for the currently logged in user.
- `totp` (optional): The 6-digit code from the authenticator app if the user has 2FA enabled.
- `iterations` (optional): The number of iterations for PBKDF2 SHA256 password hashing.
- `iterations` (optional): The number of iterations for PBKDF2 SHA256 password hashing. Valid range is from 100000 to 1000000. Default value when not specified is 100000.
RESPONSE:
```
@@ -5249,6 +5249,7 @@ RESPONSE:
"cacheMaximumRecordTtl": 604800,
"cacheNegativeRecordTtl": 300,
"cacheFailureRecordTtl": 10,
"enableCachePrefetch": true,
"cachePrefetchEligibility": 2,
"cachePrefetchTrigger": 9,
"enableBlocking": true,
@@ -5407,8 +5408,9 @@ WHERE:
- `cacheMaximumRecordTtl` (optional): The maximum TTL value that a record can have in cache. Set a lower value to allow the records to expire early. Initial value is `86400`.
- `cacheNegativeRecordTtl` (optional): The negative TTL value to use when there is no SOA MINIMUM value available. Initial value is `300`.
- `cacheFailureRecordTtl` (optional): The failure TTL value to used for caching failure responses. This allows storing failure record in cache and prevent frequent recursive resolution to name servers that are responding with `ServerFailure`. Initial value is `60`.
- `enableCachePrefetch` (optional): Set this option to `true` to refresh records that are about to expire in cache. A prefetch background task for a cached record is triggered when it is queried for and the DNS server finds the record's TTL value to be less than the Prefetch Trigger value.
- `cachePrefetchEligibility` (optional): The minimum initial TTL value of a record needed to be eligible for prefetching.
- `cachePrefetchTrigger` (optional): A record with TTL value less than trigger value will initiate prefetch operation immediately for itself. Set `0` to disable prefetching & auto prefetching.
- `cachePrefetchTrigger` (optional): A record with TTL value less than trigger value will initiate prefetch operation immediately for itself when queried.
- `enableBlocking` (optional, cluster parameter): Sets the DNS server to block domain names using Blocked Zone and Block List Zone.
- `allowTxtBlockingReport` (optional, cluster parameter): Specifies if the DNS Server should respond with TXT records containing a blocked domain report for TXT type requests.
- `blockingBypassList` (optional, cluster parameter): A comma separated list of IP addresses or network addresses that are allowed to bypass blocking.
@@ -7212,14 +7214,14 @@ RESPONSE:
"response": {
"clusterInitialized": true,
"dnsServerDomain": "server1.example.com",
"version": "14.0",
"version": "15.6",
"clusterDomain": "example.com",
"heartbeatRefreshIntervalSeconds": 30,
"heartbeatRetryIntervalSeconds": 10,
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-26T12:30:16Z",
"nodes": [
"clusterNodes": [
{
"id": 1342079372,
"name": "server1.example.com",
@@ -7227,6 +7229,7 @@ RESPONSE:
"ipAddress": "192.168.10.5",
"type": "Secondary",
"state": "Self",
"version": "15.6,
"lastSeen": "0001-01-01T00:00:00"
},
{
@@ -7245,6 +7248,7 @@ RESPONSE:
"ipAddress": "192.168.10.102",
"type": "Primary",
"state": "Connected",
"version": "15.6,
"lastSeen": "2025-09-26T12:30:16Z"
}
],
@@ -7294,7 +7298,7 @@ RESPONSE:
"heartbeatRetryIntervalSeconds": 10,
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"nodes": [
"clusterNodes": [
{
"id": 1081800048,
"name": "server1.example.com",
@@ -7377,7 +7381,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-26T12:30:16Z",
"nodes": [
"clusterNodes": [
{
"id": 1342079372,
"name": "server1.example.com",
@@ -7435,7 +7439,7 @@ RESPONSE:
"heartbeatRetryIntervalSeconds": 10,
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"nodes": [
"clusterNodes": [
{
"id": 1151850285,
"name": "server1.example.com",
@@ -7482,7 +7486,7 @@ RESPONSE:
"heartbeatRetryIntervalSeconds": 10,
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"nodes": [
"clusterNodes": [
{
"id": 1151850285,
"name": "server1.example.com",
@@ -7533,7 +7537,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-26T12:30:16Z",
"nodes": [
"clusterNodes": [
{
"id": 1342079372,
"name": "server1.example.com",
@@ -7618,7 +7622,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-26T12:30:16Z",
"nodes": [
"clusterNodes": [
{
"id": 1342079372,
"name": "server1.example.com",
@@ -7692,7 +7696,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-27T13:19:55Z",
"nodes": [
"clusterNodes": [
{
"id": 1151850285,
"name": "server1.example.com",
@@ -7835,7 +7839,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-27T13:19:55Z",
"nodes": [
"clusterNodes": [
{
"id": 1151850285,
"name": "server1.example.com",
@@ -7899,7 +7903,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-27T13:19:55Z",
"nodes": [
"clusterNodes": [
{
"id": 811905692,
"name": "server2.example.com",
@@ -7948,7 +7952,7 @@ RESPONSE:
"configRefreshIntervalSeconds": 900,
"configRetryIntervalSeconds": 60,
"configLastSynced": "2025-09-27T13:19:55Z",
"nodes": [
"clusterNodes": [
{
"id": 811905692,
"name": "server2.example.com",