Pi-hole


The pi_hole integration allows you to retrieve statistics and interact with a single Pi-hole system.

Configuration

To enable this integration with the default configuration, add the following lines to your configuration.yaml file

# Example configuration.yaml entry
pi_hole:

Configuration Variables

host

(string)(Optional)

The hostname (and port), e.g., ‘192.168.0.3:4865’ of the host where Pi-hole is running. If your Pi-Hole instance is the Hass.io add-on, you must specify port 4865.

Default value:

pi.hole

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 SSL/TLS certificate of the system. If your Pi-Hole instance uses a self-signed certificate, you should specify false.

Default value:

true

api_key

(string)(Optional)

API Key for interacting with the Pi-hole. This is not required if you want to just query the Pi-hole for usage statistics.

Default value:

None

Full example

# Example configuration.yaml entry
pi_hole:
  host: 'localhost:4865'
  ssl: false
  verify_ssl: false

Services

The platform provides the following services to interact with your Pi-hole.

Service pi_hole.disable

Disable your Pi-hole for the specified amount of time.

Service data attribute Required Type Description
duration True timedelta Time for which Pi-hole should be disabled

Note: This service requires api_key to be specified in the configuration.

Service pi_hole.enable

Enable your Pi-hole.

Note: This service requires api_key to be specified in the configuration.

This integration 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.