Pi-hole


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

Configuration

Adding Pi-hole to your Home Assistant instance can be done via the user interface, by taking the following steps:

  • Browse to your Home Assistant instance.

  • In the sidebar click on Configuration.

  • From the configuration menu select: Integrations.

  • In the bottom right, click on the Add Integration button.

  • From the list, search and select “Pi-hole”.

  • Follow the instruction on screen to complete the set up.

After completing, the Pi-hole integration will be immediately available for use.

Please note, that during the integration set up, an API key can be provided. Providing one, gives access to the Pi-Hole disable service and a switch to enable/disable Pi-Hole from Home Assistant.

Services

The platform provides the following services to interact with your Pi-hole. Use switch entities when calling the services.

Service pi_hole.disable

Disables configured Pi-hole(s) for the specified amount of time.

Service data attribute Required Type Description
entity_id False string Target switch entity. Use all to target all Pi-hole services
duration True timedelta Time for which Pi-hole should be disabled