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

# Flush DNS Cache

## Endpoint

`/api/cache/flush`

**Obsolete Path:** `/api/flushDnsCache`

## Method

GET

## Description

Clears the entire DNS cache from the server, forcing the DNS server to make fresh recursive queries to repopulate the cache. This is a bulk operation that removes all cached entries, unlike `cache/delete` which targets a specific domain.

## Parameters

| Name | Type | Required | Conditional | Description |
|------|------|----------|-------------|-------------|
| `token` | string | Yes | No | The session token generated by the `login` or `createToken` call. |

## Authentication

Required. A valid session token must be provided via the `token` parameter.

## Permissions

Cache: Delete

## Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `status` | string | `"ok"` on success. |

## Conditional Logic Notes

- This is a destructive bulk operation. All cached DNS records are removed, not just a specific domain.
- Uses the same permission level (`Cache: Delete`) as the targeted `cache/delete` action. There is no separate "flush" permission.
- After flushing, the DNS server will experience temporarily increased latency as it must perform recursive resolution for all queries until the cache is repopulated.

## Edge Cases

- Flushing an already-empty cache should still return `"ok"` (idempotent).
- This operation may cause a brief spike in outbound DNS traffic as the server re-resolves previously cached domains.
- No confirmation prompt is provided by the API; the flush is immediate upon request.
- There is no partial flush capability at this endpoint. To selectively remove entries, use `cache/delete` instead.