---
title: PiHole
description: PiHole Widget Configuration
---

Learn more about [PiHole](https://github.com/pi-hole/pi-hole).

As of v2022.12 [PiHole requires the use of an API key](https://pi-hole.net/blog/2022/11/17/upcoming-changes-authentication-for-more-api-endpoints-required/#page-content) if an admin password is set. Older versions do not require any authentication even if the admin uses a password.

Allowed fields: `["queries", "blocked", "blocked_percent", "gravity"]`.

Note: by default the "blocked" and "blocked_percent" fields are merged e.g. "1,234 (15%)" but explicitly including the "blocked_percent" field will change them to display separately.

```yaml
widget:
  type: pihole
  url: http://pi.hole.or.ip
  version: 6 # required if running v6 or higher, defaults to 5
  key: yourpiholeapikey # optional
```

_Added in v0.1.0, updated in v0.8.9_
