Pi-hole for Home Assistant (built-in integration)

About

Pi-hole is a built-in integration that connects Home Assistant to a Pi-hole DNS ad blocker over the local network. It adds a status binary sensor, sensors for ads blocked, DNS queries, clients, domains and blocked percentages, and update entities for the core, FTL and web components. Switches are also provided, and an action can disable the configured Pi-hole for a set amount of time. Setup happens in the UI and asks for an app password or API key, host, port, location, and SSL options. A repair notice appears after a migration from Pi-hole API v5 to v6, and a diagnostics file can be downloaded for bug reports.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Switches
Sensors

Setting it up

It is added under Settings, Devices and services, with Add integration.

Connect

App password or API key
Host
Location
Port
Uses an SSL certificate
Verify SSL certificate

Reauthenticate Pi-hole

API key

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsStatus
SensorsAds blocked, Ads blocked today, Ads percentage blocked today, Seen clients, DNS queries, DNS queries today, Domains blocked, Ads percentage blocked, DNS queries cached, DNS queries forwarded, DNS unique clients, DNS unique domains
UpdatesCore update available, FTL update available, Web update available

Actions

DisableDisables configured Pi-hole(s) for an amount of time.Fields: Duration

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Recent migration from Pi-hole API v5 to v6