Python API Client for Pi-hole 6
Project description
🍓 pihole6api
This package provides a simple, modular SDK for the PiHole 6 REST API.
Features
- Automatically handles authentication and renewal
- Gracefully error management
- Logically organized modules
- Easily maintained
Installation
Install using pip
or pipx
:
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 |
padd |
Fetch summarized data for PADD |
License
This project is license under the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pihole6api-0.1.2.tar.gz
(11.8 kB
view details)
Built Distribution
File details
Details for the file pihole6api-0.1.2.tar.gz
.
File metadata
- Download URL: pihole6api-0.1.2.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
ed3d6880a6db97fb7f436aba9087d936c7c29693a7a676a85c9b61a5a462bfa4
|
|
MD5 |
81838298b3bc3c17e4e5eabb7486c96a
|
|
BLAKE2b-256 |
6f5a1a87abc03d586df83bb26611a7348ce7c3170e8584d0536c04dbaee92353
|
File details
Details for the file pihole6api-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: pihole6api-0.1.2-py3-none-any.whl
- Upload date:
- Size: 15.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
621ec1cfe831f3283d95e146384e3feeabcde33eb42c8d4150c1188ebe3203be
|
|
MD5 |
46ec59287f93ff6a4554786802cd85d8
|
|
BLAKE2b-256 |
2ff106b6a3ef3824ca146957a4096abaf1b3a594dea53c421f04283b5d665bab
|