pi-hole/web
1
0
Fork 0
mirror of https://github.com/pi-hole/web.git synced 2024-12-06 19:36:21 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added documentation for API

Browse Source
This commit is contained in:
Brice Johnson
2016-01-09 20:10:02 -06:00
parent 8479530c67
commit fc33965906
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -1
View File
@@ -7,4 +7,15 @@ Using **[AdminLTE](https://almsaeedstudio.com)**, this project will create a Web
From this interface, you will be able to see stats on how well your Pi-hole is performing. You will also be able to update the lists used to block ads.
![Pi-hole Web interface](http://i.imgur.com/x2iMfoc.png)
![Fully responsive](http://i.imgur.com/NyAIXm8.png)
![Fully responsive](http://i.imgur.com/NyAIXm8.png)
## API
A basic read-only API can be accessed at `/admin/api.php`. It returns the following JSON:
```JSON
{
"domains_being_blocked": "136708",
"dns_queries_today": "18108",
"ads_blocked_today": "14648",
"ads_percentage_today": 80.892423238348
}
```