Pi-hole

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

    配置

    此集成可通过 UI 配置。前往 设置 > 设备与服务 添加。

    During the setup, it will ask for the following:

    ItemDescriptionExample
    HostThe IP or domain name to Pi-Hole.192.168.1.1
    PortPort used to get to the admin page, typically 80 for http connections and 443 for https connections.80
    NameName to for this Pi-Hole.Pi-Hole
    Locationthe path to the admin page. In the version 6 API this will be ignored./admin
    API Key or App PasswordThis can be found in your Pi-hole's Settings > API (expert mode).585a2fe...
    Uses an SSL certificateWhether your Pi-hole has an Certificate, typically true for https connections and false for http.[openmoji:check-mark]
    Verify SSL certificateWhether to use verify your Pi-hole's certificate, ignored in Pi-hole API version 5.[openmoji:check-mark]

    The combined host, port and location should take you to the login page of Pi-Hole. Using the example above, it would be http://192.168.1.1:80/admin.

    To find your App Password, log into your Pi-Hole and go to Settings > Web Interface/API. Switch from Basic to Expert mode, then select Configure app password. Your admin login password may be used instead but this is not recommended.

    Versions of Pi-hole before version 6 (released in Feb 2025) use an API Key if the Pi-hole was password protected, this can be found in Settings > API Tab and clicking Show API token.

    Actions

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

    Action: Disable

    The pi_hole.disable action disables configured Pi-hole(s) for the specified amount of time.

    Data attributeRequiredTypeDescription
    entity_idFalsestringTarget switch entity. Use all to target all Pi-hole services.
    durationTruetimedeltaTime for which Pi-hole should be disabled. '0' will enable blocking indefinitely.

    Example action:

    # Example action to disable Pi-Hole for 30 minutes
action: pi_hole.disable
data:
  duration: '00:30'
target:
  entity_id: all

    Switches

    The integration creates a switch for the Pi-hole allowing you to toggle ad-blocking on and off.

    Sensors

    The integration creates a number of sensors which report various ad-blocking metrics as well as diagnostic information about the pi-hole itself.