technitium 0.4.0

Typed async Rust client for the Technitium DNS Server API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# Admin: Delete Cluster

## Endpoint

`/api/admin/cluster/primary/delete`

## Method

GET

## Description

Removes all Cluster configuration from this Primary node. There will be no data loss except for the Cluster configuration. You will need to re-initialize the Cluster to use clustering features again. This call can only be made at the Primary node.

The Cluster can only be deleted when there are no Secondary nodes remaining. Use the `forceDelete` option only when you wish to remove this Primary node from the Cluster even when Secondary nodes still exist, which will orphan them (requiring manual promotion of one to Primary).

## Authentication

Required. Token must be provided via the `token` parameter.

## Permissions

Administration: Delete

## Parameters

| Name | Type | Required | Conditional | Description |
|------|------|----------|-------------|-------------|
| `token` | string | Yes | No | The session token generated by the `login` or the `createToken` call. |
| `node` | string | No | No | The node domain name for which the API call is intended. When unspecified, the current node is used. Can only be used when Clustering is initialized. |
| `forceDelete` | boolean | No | No | Set to `true` to force delete the Cluster even when Secondary nodes still exist, orphaning them. Default is `false`. |

## Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `clusterInitialized` | boolean | Will be `false` after successful deletion. |
| `dnsServerDomain` | string | The server domain name (reverted to short hostname after cluster deletion). |
| `version` | string | The DNS server software version. |

## Conditional Logic Notes

- This call can only be made at the Primary node.
- Without `forceDelete=true`, the call will fail if Secondary nodes still exist in the cluster.
- With `forceDelete=true`, Secondary nodes become orphaned and one must be manually promoted to Primary.

## Edge Cases

- After deletion, the `dnsServerDomain` reverts from an FQDN (e.g., `server1.example.com`) to a short hostname (e.g., `server1`).
- Force-deleting with active Secondary nodes will leave those nodes in an inconsistent state until one is promoted to Primary.
- The cluster configuration is lost permanently; re-initialization creates a new cluster.