[pihole] Refine API key procedure (#19920)

* Refines API key procedure

Signed-off-by: Erik De Boeck <deboeck.erik@gmail.com>
This commit is contained in:
ErikDB87
2026-05-06 22:45:52 +02:00
committed by GitHub
parent a015cbcf5b
commit 70405cea66
+13 -6
View File
@@ -21,16 +21,23 @@ The Pi-hole Binding allows you to monitor Pi-hole statistics and control its fun
### `server` Thing Configuration
| Name | Type | Description | Default | Required | Advanced |
|-----------------|---------|--------------------------------------------------------------------------------------------|---------|----------|----------|
| hostname | text | URL (hostname or IP address) of the pihole web server | N/A | yes | no |
| token | text | Token to access the device. To generate token, go to `settings` > `API` > `Show API token` | N/A | yes | no |
| refreshInterval | integer | Interval the device is polled in sec | 600 | no | yes |
| Name | Type | Description | Default | Required | Advanced |
| --------------- | ------- | ----------------------------------------------------- | ------- | -------- | -------- |
| hostname | text | URL (hostname or IP address) of the pihole web server | N/A | yes | no |
| token | text | Token to access the device (see below) | N/A | yes | no |
| refreshInterval | integer | Interval the device is polled in sec | 600 | no | yes |
### Generating a token
The procedure for generating a token in version 5 is different from generating one in version 6:
- Version 5: Go to `settings` > `API` > `Show API token`
- Version 6: Go to `settings` > `Web Interface - API Settings` > `Expert` > `Configure app password` > Copy the `app password` > `Enable new app password`
## Channels
| Channel | Type | Read/Write | Description |
|-------------------------|----------------------|------------|------------------------------------------------------------|
| ----------------------- | -------------------- | ---------- | ---------------------------------------------------------- |
| domains-being-blocked | Number | RO | The total number of domains currently being blocked. |
| dns-queries-today | Number | RO | The count of DNS queries made today. |
| ads-blocked-today | Number | RO | The number of ads blocked today. |