pihole6api 0.1.5

Python API Client for Pi-hole 6

🍓 pihole6api

This package provides a simple, modular SDK for the PiHole 6 REST API.

Features

• Automatically handles authentication and renewal
• Graceful error management
• Logically organized modules
• Easily maintained

Installation

Install using pip:

pip install pihole6api

Install from source:

git clone https://github.com/sbarbett/pihole6api.git
cd pihole6api
pip install -e .

Quick Start

Initialize the Client

from pihole6api import PiHole6Client
client = PiHole6Client("https://your-pihole.local/", "your-password")

Example Usage

Get Pi-Hole Metrics

history = client.metrics.get_history()
print(history)  # {'history': [{'timestamp': 1740120900, 'total': 0, 'cached': 0 ...}]}
queries = client.metrics.get_queries()
print(queries)

Enable/Disable Blocking

client.dns_control.set_blocking_status(False, 60)
print(client.dns_control.get_blocking_status()) # {'blocking': 'disabled', 'timer': 60 ...}

Manage Groups

client.group_management.add_group("Custom Group", comment="For testing")
client.group_management.delete_group("Custom Group")

Manage Domains

client.domain_management.add_domain("ads.example.com", "deny", "exact")
client.domain_management.delete_domain("ads.example.com", "deny", "exact")

Manage Links

client.list_management.add_list("https://example.com/blocklist.txt", "block")
client.list_management.delete_list("https://example.com/blocklist.txt", "block")

Export/Import PiHole Settings

# Export settings and save as a .zip file
with open("pihole-settings.zip", "wb") as f:
    f.write(client.config.export_settings())

client.config.import_settings("pihole-settings.zip", {"config": True, "gravity": {"group": True}})

Flush Logs & Restart DNS

client.actions.flush_logs()
client.actions.restart_dns()

API Modules

Module	Description
metrics	Query history, top clients/domains, DNS stats
dns_control	Enable/disable blocking
group_management	Create, update, and delete groups
domain_management	Allow/block domains (exact & regex)
client_management	Manage client-specific rules
list_management	Manage blocklists (Adlists)
config	Modify Pi-hole configuration
ftl_info	Get Pi-hole core process (FTL) info
dhcp	Manage DHCP leases
network_info	View network devices, interfaces, routes
actions	Flush logs, restart services

License

This project is license under the MIT license.