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

# Check For Update

## Endpoint

`/api/user/checkForUpdate`

**Obsolete Path:** `/api/checkForUpdate`

## Method

GET

## Description

Requests the server to check for software updates and returns information about available updates including version details and download links.

## Parameters

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

## Authentication

Requires a valid token (session token from login or API token from createToken).

## Response Fields

| Field | Type | Description |
|-------|------|-------------|
| `response.updateAvailable` | boolean | Whether a newer version is available. |
| `response.updateVersion` | string | The version number of the available update. |
| `response.currentVersion` | string | The currently installed version number. |
| `response.updateTitle` | string | A title/heading for the update notification. |
| `response.updateMessage` | string | A message with instructions or notes about the update. |
| `response.downloadLink` | string | URL to download the update package. |
| `response.instructionsLink` | string | URL to update instructions/documentation. |
| `response.changeLogLink` | string | URL to the changelog for the update. |

## Conditional Logic Notes

- When `updateAvailable` is `false`, the other update-related fields (`updateVersion`, `downloadLink`, etc.) may be absent or empty.
- This endpoint works with both login session tokens and API tokens.

## Edge Cases

- The obsolete path `/api/checkForUpdate` is still supported but deprecated.
- The response fields like `downloadLink`, `instructionsLink`, and `changeLogLink` are URLs pointing to external resources -- they may change between server versions.
- When no update is available, the response structure may differ (fewer fields present).
- This endpoint likely makes an outbound network request from the DNS server to check for updates, which may fail if the server has no internet access.