Last Updated:

Enhanced Pi-hole Functionality with API v6

S.C.O.R.E.ConvenienceDevice Control

Overview

Pi-hole users can now take advantage of the new API v6 functionality, streamlining ad-blocking processes and enhancing network visibility. This update allows for better device control and improved integration with home capability systems.

Convenience icon

Benefits

  • Simplifies ad-blocking management for all devices connected to the home network.
  • Enables real-time monitoring of network requests and block statuses.
  • Improves integration capabilities with Home Assistant and other smart home applications.

Intent

The purpose of this capability is to provide Pi-hole users with advanced features through the API v6, enabling them to manage their network more effectively. This results in a more streamlined home network experience, reducing unwanted ads and improving overall performance.

Preconditions

  • A functioning Pi-hole installation on the home network.
  • Home Assistant set up to communicate with Pi-hole using API v6.
  • Home Assistant installed and configured.
  • Integration available and authenticated: UniFi.
  • Device installed and reachable: Synology 1621+ Network Attached Storage (NAS).

Actors

  • Homeowner
  • Family member
  • Guest

Trigger

The capability is triggered by the homeowner accessing the Pi-hole dashboard or by changes in network device status.

Workflow Diagram

flowchart TD
    A[Access Pi-hole Dashboard] -->|check| B{{API v6 Enabled?}}
    B -->|Yes| C[Manage Ad-Blocking]
    C --> D[Display Network Stats]
    B -->|No| E[Enable API v6]

Workflow Description

1. Access Pi-hole Dashboard

The homeowner navigates to the Pi-hole web interface to manage settings.

2. Check API v6 Status

The system verifies if API v6 functionality is enabled.

3. Enable API v6

If not enabled, the homeowner can activate API v6 through the settings.

4. Manage Ad-blocking Settings

The homeowner adjusts ad-blocking preferences and views device lists.

5. Monitor Network Activity

Real-time statistics are displayed, showing which domains are being blocked.

Postconditions

After completing the process, the homeowner has full access to enhanced ad-blocking features and real-time monitoring of network activity.

Optional Enhancements

  • Integrate with voice assistants for hands-free management.
  • Set up automated reports on blocked domains and device activity.
  • Create notifications for unusual network activity.

Recommended Components

Recommended ApplicationsRecommended IntegrationsRecommended Devices
Home AssistantUniFi, Zigbee2MQTTSynology 1621+ Network Attached Storage (NAS), Unifi Networks

Source Examples