Pi-hole Sensor


The pi_hole sensor platform displays the statistical summary of a Pi-hole system.

Configuration

To enable this sensor, add the following lines to your configuration.yaml file for a GET request:

# Example configuration.yaml entry
sensor:
  - platform: pi_hole

Configuration Variables

host

(string)(Optional)

IP address of the host where Pi-hole is running.

Default value:

localhost

location

(string)(Optional)

The installation location of the Pi-hole API.

Default value:

admin

ssl

(boolean)(Optional)

If true, use SSL/TLS to connect to the Pi-Hole system.

Default value:

false

verify_ssl

(boolean)(Optional)

Verify the certification of the system.

Default value:

true

monitored_conditions

(list)(Optional)

Defines the stats to monitor as sensors.

Default value:

ads_blocked_today

ads_blocked_today

Total number of blocked ads today.

ads_percentage_today

Percentage of blocked ads.

dns_queries_today

Total number of DNS queries handled by Pi-hole today.

domains_being_blocked

Total number of domains blocked by Pi-hole.

queries_cached

Total number of cache queries on the last 24 hours.

queries_forwarded

Total number of forwarded queries on the last 24 hours.

unique_clients

Total number of unique clients on the last 24 hours.

unique_domains

Total number of unique domains on the last 24 hours.

clients_ever_seen

Total number of seen clients.

Full example

# Example configuration.yaml entry
sensor:
  - platform: pi_hole
    host: IP_ADDRESS
    monitored_conditions:
      - ads_blocked_today
      - ads_percentage_today
      - dns_queries_today
      - domains_being_blocked
      - queries_cached
      - queries_forwarded
      - unique_clients
      - unique_domains

This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark Pi-hole and the logo is used here to describe the platform. Pi-hole is a registered trademark of Pi-hole LLC.