Zabbix Share

Zabbix templates, modules & more
Log in
Choose social to login:
Login With Google
Login With Github

Nav view search

Navigation

Advanced Search
  • Applications
    • 1C
    • Anti-Virus
    • Backup
    • Bug and issue tracking
    • Cluster
    • Clustered File Systems
    • DNS
    • Excel Export
    • Firewall
    • HelpDesk System
    • High Availability (HA)
    • Java Application
    • Mail servers
    • Misc
    • Monitoring System
    • NFS
    • NTP
    • Others
    • Process Managers
    • Queue managers
    • Security
    • SIEM
    • Skype
    • Ticketing System
    • Time synchronization
    • TV Broadcasting
    • Web-servers
  • Cloud
  • Databases
  • Network Appliances
  • Network Devices
  • Official Templates
  • Operating Systems
  • Power (UPS)
  • Printers
  • SCADA, IoT, Energy, Home Automation, Industrial monitoring
  • Server Hardware
  • Storage Devices
  • Telephony
  • Unsorted
  • Virtualization
  • Zabbix

Pi-Hole API Popular

  • 970.png

Pi-Hole API

Auth integration:
Simply execute this command on Pi-Hole to retrieve API Token:

sudo cat /etc/pihole/setupVars.conf | grep PASSWORD | cut -d "=" -f2


Or go in the Pi-Hole WebUI > Settings > tab Api / Web Interface > button Show API Token.

Report the value in Zabbix:
Configuration > Hosts > [your Pi-Hole] > Macros Tab > new macro:

  • Macro: {$WEBPASSWORD}
  • Value: [the result of the command executed on your Pi-Hole]


 Changelog:

Update 2020.8.3 (v1.4):
- added getQueryTypes dependent items + graph:

  • MX
  • DS
  • RRSIG
  • DNSKEY
  • OTHER


Update 2020.7.9 (v1.3):
- added Auth support

Update 2020.7.8 (v1.2):
- bugfixes in existing items (preprocessing stuff)
- switch to "summaryRaw" URL (http://{HOST.IP}/admin/api.php?summaryRaw)
- link this page to Pi-Hole API FAQ
- template graphics
- new API metrics: http://{HOST.IP}/admin/api.php?getQueryTypes

getQueryTypes dependent items:

  • A (IPv4)
  • AAAA (IPv6)
  • ANY
  • NAPTR
  • PTR
  • SOA
  • SRV
  • TXT

Initiale release (v1.1):

API SummaryRaw (no auth needed): http://{HOST.IP}/admin/api.php?summaryRaw
API Dependent items:

  • Ads blocked today
  • Ads percentage today
  • DNS queries all types
  • DNS queries today
  • Domains being blocked
  • Queries cached
  • Queries forwarded
  • Reply CNAME
  • Reply IP
  • Reply NODATA
  • Reply NXDOMAIN
  • Clients ever seen
  • Unique clients
  • Unique domain
Rating
502
2 votes

Listing Details

Type
Template
Min Zabbix version
4.4.x
Features
  • HTTP Agent
Link
discourse.pi-hole.net/t/pi-hole-api/1863
Created
2020-07-06
Modified
2020-08-03 18:12:27
Version 5.0
Download (409 downloads)
1 version, '2020-08-03 18:12' modified
Tags
pi-hole, pihole, pihole-ftl, api, dns
Author
Undefined_ID
Owner
Undefined_ID
RecommendReportOwner's listing
All resources created by third parties; use at your own risk
© 2001-2018 by Zabbix SIA. All rights reserved. Trademark Policy · Contact us