mirror of
https://github.com/pi-hole/docs.git
synced 2024-12-06 19:27:12 +01:00
Change to heading style for API documentation
Signed-off-by: Christian König <ckoenig@posteo.de>
This commit is contained in:
Christian König
+170
-134
@@ -1,180 +1,216 @@
|
||||
Connect via e.g. `telnet 127.0.0.1 4711` or use `echo ">command" | nc 127.0.0.1 4711`
|
||||
|
||||
- `>quit`: Closes the connection to the client
|
||||
#### `>quit` {data-toc-label='quit'}
|
||||
|
||||
- `>stats` : Get current statistics
|
||||
Closes the connection to the client
|
||||
|
||||
```text
|
||||
domains_being_blocked 116007
|
||||
dns_queries_today 30163
|
||||
ads_blocked_today 5650
|
||||
ads_percentage_today 18.731558
|
||||
unique_domains 1056
|
||||
queries_forwarded 4275
|
||||
queries_cached 20238
|
||||
clients_ever_seen 11
|
||||
unique_clients 9
|
||||
status enabled
|
||||
```
|
||||
#### `>stats` {data-toc-label='stats'}
|
||||
|
||||
- `>overTime` : over time data (10 min intervals)
|
||||
Get current statistics
|
||||
|
||||
```text
|
||||
1525546500 163 0
|
||||
1525547100 154 1
|
||||
1525547700 164 0
|
||||
1525548300 167 0
|
||||
1525548900 151 0
|
||||
1525549500 143 0
|
||||
[...]
|
||||
```
|
||||
```text
|
||||
domains_being_blocked 116007
|
||||
dns_queries_today 30163
|
||||
ads_blocked_today 5650
|
||||
ads_percentage_today 18.731558
|
||||
unique_domains 1056
|
||||
queries_forwarded 4275
|
||||
queries_cached 20238
|
||||
clients_ever_seen 11
|
||||
unique_clients 9
|
||||
status enabled
|
||||
```
|
||||
|
||||
- `>top-domains` : get top domains
|
||||
#### `>overTime` {data-toc-label='overTime'}
|
||||
|
||||
```text
|
||||
0 8462 x.y.z.de
|
||||
1 236 safebrowsing-cache.google.com
|
||||
2 116 pi.hole
|
||||
3 109 z.y.x.de
|
||||
4 93 safebrowsing.google.com
|
||||
5 96 plus.google.com
|
||||
[...]
|
||||
```
|
||||
Get over time data (10 min intervals)
|
||||
|
||||
Variant: `>top-domains (15)` to show (up to) 15 entries
|
||||
```text
|
||||
1525546500 163 0
|
||||
1525547100 154 1
|
||||
1525547700 164 0
|
||||
1525548300 167 0
|
||||
1525548900 151 0
|
||||
1525549500 143 0
|
||||
[...]
|
||||
```
|
||||
|
||||
- `>top-ads` : get top ad domains
|
||||
#### `>top-domains` {data-toc-label='top-domains'}
|
||||
|
||||
```text
|
||||
0 8 googleads.g.doubleclick.net
|
||||
1 6 www.googleadservices.com
|
||||
2 1 cdn.mxpnl.com
|
||||
3 1 collector.githubapp.com
|
||||
4 1 www.googletagmanager.com
|
||||
5 1 s.zkcdn.net
|
||||
[...]
|
||||
```
|
||||
Get top domains
|
||||
|
||||
Variant: `>top-ads (14)` to show (up to) 14 entries
|
||||
```text
|
||||
0 8462 x.y.z.de
|
||||
1 236 safebrowsing-cache.google.com
|
||||
2 116 pi.hole
|
||||
3 109 z.y.x.de
|
||||
4 93 safebrowsing.google.com
|
||||
5 96 plus.google.com
|
||||
[...]
|
||||
```
|
||||
|
||||
- `top-clients` : get recently active top clients (IP addresses + hostnames (if available))
|
||||
Variant: `>top-domains (15)` to show (up to) 15 entries
|
||||
|
||||
```text
|
||||
0 9373 192.168.2.1 router
|
||||
1 484 192.168.2.2 work-machine
|
||||
2 8 127.0.0.1 localhost
|
||||
```
|
||||
#### `>top-ads` {data-toc-label='top-ads'}
|
||||
|
||||
Variant: `>top-clients (9)` to show (up to) 9 client entries or `>top-clients withzero (15)` to show (up to) 15 clients even if they have not been active recently (see PR #124 for further details)
|
||||
Get top ad domains
|
||||
|
||||
- `>forward-dest` : get forward destinations (IP addresses + hostnames (if available)) along with the percentage. The first result (ID -2) will always be the percentage of domains answered from blocklists, whereas the second result (ID -1) will be the queries answered from the cache
|
||||
```text
|
||||
0 8 googleads.g.doubleclick.net
|
||||
1 6 www.googleadservices.com
|
||||
2 1 cdn.mxpnl.com
|
||||
3 1 collector.githubapp.com
|
||||
4 1 www.googletagmanager.com
|
||||
5 1 s.zkcdn.net
|
||||
[...]
|
||||
```
|
||||
|
||||
```text
|
||||
-2 18.70 blocklist blocklist
|
||||
-1 67.10 cache cache
|
||||
0 14.20 127.0.0.1 localhost
|
||||
```
|
||||
Variant: `>top-ads (14)` to show (up to) 14 entries
|
||||
|
||||
Variant: `>forward-dest unsorted` to show forward destinations in unsorted order (equivalent to using `>forward-names`)
|
||||
#### `top-clients` {data-toc-label='top-clients'}
|
||||
|
||||
- `>querytypes` : get collected query types percentage
|
||||
Get recently active top clients (IP addresses + hostnames (if available))
|
||||
|
||||
```text
|
||||
A (IPv4): 53.45
|
||||
AAAA (IPv6): 45.32
|
||||
ANY: 0.00
|
||||
SRV: 0.64
|
||||
SOA: 0.05
|
||||
PTR: 0.54
|
||||
TXT: 0.00
|
||||
```
|
||||
```text
|
||||
0 9373 192.168.2.1 router
|
||||
1 484 192.168.2.2 work-machine
|
||||
2 8 127.0.0.1 localhost
|
||||
```
|
||||
|
||||
- `>getallqueries` : get all queries that FTL has in memory
|
||||
Variant: `>top-clients (9)` to show (up to) 9 client entries or `>top-clients withzero (15)` to show (up to) 15 clients even if they have not been active recently (see PR #124 for further details)
|
||||
|
||||
```text
|
||||
1525554586 A fonts.googleapis.com 192.168.2.100 3 0 4 6
|
||||
1525554586 AAAA fonts.googleapis.com 192.168.2.100 3 0 4 5
|
||||
1525554586 A www.mkdocs.org 192.168.2.100 3 0 4 7
|
||||
1525554586 AAAA www.mkdocs.org 192.168.2.100 2 0 3 21
|
||||
1525554586 A squidfunk.github.io 192.168.2.100 2 0 3 20
|
||||
1525554586 A pi-hole.net 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA squidfunk.github.io 192.168.2.100 3 0 1 6
|
||||
1525554586 AAAA pi-hole.net 192.168.2.100 2 0 1 18
|
||||
1525554586 A github.com 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA github.com 192.168.2.100 2 0 1 18
|
||||
```
|
||||
#### `>forward-dest` {data-toc-label='forward-dest'}
|
||||
|
||||
Variants: `>getallqueries (37)` show (up to) 37 latest entries, `>getallqueries-time 1483964295 1483964312` gets all queries that FTL has in its database in a limited time interval, `>getallqueries-time 1483964295 1483964312 (17)` show matches in the (up to) 17 latest entries, `>getallqueries-domain www.google.com` gets all queries that FTL has in its database for a specific domain name, `>getallqueries-client 2.3.4.5` : gets all queries that FTL has in its database for a specific client name *or* IP
|
||||
Get forward destinations (IP addresses + hostnames (if available)) along with the percentage. The first result (ID -2) will always be the percentage of domains answered from blocklists, whereas the second result (ID -1) will be the queries answered from the cache
|
||||
|
||||
- `>recentBlocked` : get most recently pi-holed domain name
|
||||
```text
|
||||
-2 18.70 blocklist blocklist
|
||||
-1 67.10 cache cache
|
||||
0 14.20 127.0.0.1 localhost
|
||||
```
|
||||
|
||||
```text
|
||||
www.googleadservices.com
|
||||
```
|
||||
Variant: `>forward-dest unsorted` to show forward destinations in unsorted order (equivalent to using `>forward-names`)
|
||||
|
||||
Variant: `>recentBlocked (4)` show the four most recent blocked domains
|
||||
#### `>querytypes` {data-toc-label='querytypes'}
|
||||
|
||||
- `>clientID` : Get ID of currently connected client
|
||||
Get collected query types percentage
|
||||
|
||||
```text
|
||||
6
|
||||
```
|
||||
```text
|
||||
A (IPv4): 53.45
|
||||
AAAA (IPv6): 45.32
|
||||
ANY: 0.00
|
||||
SRV: 0.64
|
||||
SOA: 0.05
|
||||
PTR: 0.54
|
||||
TXT: 0.00
|
||||
```
|
||||
|
||||
- `>version` : Get version information of the currently running FTL instance
|
||||
#### `>getallqueries` {data-toc-label='getallqueries'}
|
||||
|
||||
```text
|
||||
version v1.6-3-g106498d-dirty
|
||||
tag v1.6
|
||||
branch master
|
||||
hash 106498d
|
||||
date 2017-03-26 13:10:43 +0200
|
||||
```
|
||||
Get all queries that FTL has in memory
|
||||
|
||||
- `>dbstats` : Get some statistics about `FTL`'s' long-term storage database (this request may take some time for processing in case of a large database file)
|
||||
```text
|
||||
1525554586 A fonts.googleapis.com 192.168.2.100 3 0 4 6
|
||||
1525554586 AAAA fonts.googleapis.com 192.168.2.100 3 0 4 5
|
||||
1525554586 A www.mkdocs.org 192.168.2.100 3 0 4 7
|
||||
1525554586 AAAA www.mkdocs.org 192.168.2.100 2 0 3 21
|
||||
1525554586 A squidfunk.github.io 192.168.2.100 2 0 3 20
|
||||
1525554586 A pi-hole.net 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA squidfunk.github.io 192.168.2.100 3 0 1 6
|
||||
1525554586 AAAA pi-hole.net 192.168.2.100 2 0 1 18
|
||||
1525554586 A github.com 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA github.com 192.168.2.100 2 0 1 18
|
||||
```
|
||||
|
||||
```text
|
||||
queries in database: 2700304
|
||||
database filesize: 199.20 MB
|
||||
SQLite version: 3.23.1
|
||||
```
|
||||
Variants: `>getallqueries (37)` show (up to) 37 latest entries, `>getallqueries-time 1483964295 1483964312` gets all queries that FTL has in its database in a limited time interval, `>getallqueries-time 1483964295 1483964312 (17)` show matches in the (up to) 17 latest entries, `>getallqueries-domain www.google.com` gets all queries that FTL has in its database for a specific domain name, `>getallqueries-client 2.3.4.5` : gets all queries that FTL has in its database for a specific client name *or* IP
|
||||
|
||||
- `>domain pi-hole.net`: Get detailed information about domain (if available)
|
||||
#### `>recentBlocked` {data-toc-label='recentBlocked'}
|
||||
|
||||
```text
|
||||
Domain "pi-hole.net", ID: 254
|
||||
Total: 179
|
||||
Blocked: 0
|
||||
Wildcard blocked: false
|
||||
```
|
||||
Get most recently pi-holed domain name
|
||||
|
||||
- `>cacheinfo`: Get DNS server cache size and usage information
|
||||
```text
|
||||
www.googleadservices.com
|
||||
```
|
||||
|
||||
```text
|
||||
cache-size: 500000
|
||||
cache-live-freed: 0
|
||||
cache-inserted: 15529
|
||||
```
|
||||
Variant: `>recentBlocked (4)` show the four most recent blocked domains
|
||||
|
||||
- `>dns-port`: Get DNS port FTL is listening on
|
||||
#### `>clientID` {data-toc-label='clientID'}
|
||||
|
||||
```text
|
||||
53
|
||||
```
|
||||
Get ID of currently connected client
|
||||
|
||||
- `>maxlogage`: Get timespan of the statistics shown on the dashboard (in seconds)
|
||||
```text
|
||||
6
|
||||
```
|
||||
|
||||
```text
|
||||
86400
|
||||
```
|
||||
#### `>version` {data-toc-label='version'}
|
||||
|
||||
Note that the port can also be `0` if someone decides to disable the DNS server part of Pi-hole
|
||||
Get version information of the currently running FTL instance
|
||||
|
||||
- `>gateway`: Get the IP of the gateway of the default route and the corresponding interface
|
||||
```text
|
||||
version v1.6-3-g106498d-dirty
|
||||
tag v1.6
|
||||
branch master
|
||||
hash 106498d
|
||||
date 2017-03-26 13:10:43 +0200
|
||||
```
|
||||
|
||||
```text
|
||||
192.168.0.1 enp2s0
|
||||
```
|
||||
#### `>dbstats` {data-toc-label='dbstats'}
|
||||
|
||||
Note that if no non-default route could be found, `0.0.0.0` and an empty interface string is returned
|
||||
Get some statistics about `FTL`'s' long-term storage database (this request may take some time for processing in case of a large database file)
|
||||
|
||||
```text
|
||||
queries in database: 2700304
|
||||
database filesize: 199.20 MB
|
||||
SQLite version: 3.23.1
|
||||
```
|
||||
|
||||
#### `>domain pi-hole.net` {data-toc-label='domain'}
|
||||
|
||||
Get detailed information about domain (if available)
|
||||
|
||||
```text
|
||||
Domain "pi-hole.net", ID: 254
|
||||
Total: 179
|
||||
Blocked: 0
|
||||
Wildcard blocked: false
|
||||
```
|
||||
|
||||
#### `>cacheinfo` {data-toc-label='cacheinfo'}
|
||||
|
||||
Get DNS server cache size and usage information
|
||||
|
||||
```text
|
||||
cache-size: 500000
|
||||
cache-live-freed: 0
|
||||
cache-inserted: 15529
|
||||
```
|
||||
|
||||
#### `>dns-port` {data-toc-label='dns-port'}
|
||||
|
||||
Get DNS port FTL is listening on
|
||||
|
||||
```text
|
||||
53
|
||||
```
|
||||
|
||||
Note that the port can also be `0` if someone decides to disable the DNS server part of Pi-hole
|
||||
|
||||
#### `>maxlogage` {data-toc-label='maxlogage'}
|
||||
|
||||
Get timespan of the statistics shown on the dashboard (in seconds)
|
||||
|
||||
```text
|
||||
86400
|
||||
```
|
||||
|
||||
#### `>gateway` {data-toc-label='gateway'}
|
||||
|
||||
Get the IP of the gateway of the default route and the corresponding interface
|
||||
|
||||
```text
|
||||
192.168.0.1 enp2s0
|
||||
```
|
||||
|
||||
Note that if no non-default route could be found, `0.0.0.0` and an empty interface string is returned
|
||||
|
||||
{!abbreviations.md!}
|
||||
|
||||
Reference in New Issue
Block a user