PoshPiHole

0.6.0

PowerShell module for interacting with the Pi-hole v6 API

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PoshPiHole

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name PoshPiHole

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

ptmorris

Copyright

2025 Patrick Morris

Package Details

Author(s)

Patrick Morris

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

# 📅 Changelog

All notable changes to the **PoshPiHole** module will be documented in this file.

---

## [0.6.0] - 2025-08-11

### Added

* `Get-PiHoleDbHistory` – Retrieves activity graph data (long-term data) from Pi-hole (`GET /api/history/database`).
* `Get-PiHoleDbHistoryClients` – Retrieves per-client activity graph data (long-term data) from Pi-hole (`GET /api/history/database/clients`).
* `Get-PiHoleDbQueryTypes` – Retrieves query types data from the Pi-hole long-term database (`GET /api/stats/database/query_types`).
* `Get-PiHoleDbTopClients` – Retrieves top clients data from the Pi-hole long-term database (`GET /api/stats/database/top_clients`).
* `Get-PiHoleDbTopDomains` – Retrieves top domains data from the Pi-hole long-term database (`GET /api/stats/database/top_domains`).
* `Get-PiHoleDbUpstreams` – Retrieves metrics about Pi-hole's upstream destinations from the long-term database (`GET /api/stats/database/upstreams`).

---

## [0.5.0] - 2025-05-28

### Added

* `Get-PiHoleList` – Retrieves the configured adlists from Pi-hole (`GET /lists`).
* `Search-PiHoleDomain` – Search for domains in Pi-hole's lists (`GET /search/{domain}`).
* `Get-PiHoleHost` – Retrieves host information from Pi-hole (`GET /info/host`).
* `Get-PiHoleTeleporter` – Downloads a Pi-hole Teleporter backup as a .zip file (`GET /teleporter`).

---

## [0.4.0] - 2025-05-23

### Added

* `Get-PiHoleSessions` – Retrieves the current Pi-hole sessions (`GET /auth/sessions`).
* `Get-PiHoleClientHistory` – Retrieves per-client activity graph data (`GET /history/clients`).

---

## [0.3.0] - 2025-05-11

### Added

* `Get-PiHoleSystemInfo` – Retrieves detailed system information from Pi-hole (`GET /info/system`).
* `Get-PiHoleVersion` – Retrieves version information for Pi-hole and its components (`GET /info/version`).

### Fixed

* `Disconnect-PiHole` will now delete multiple IDs as expected.

---

## [0.2.2] - 2025-05-10

### Fixed

* `Disconnect-PiHole` will now delete multiple IDs as expected.

---

## [0.2.1] - 2025-04-30

### Fixed

* Resolved issues with `Enable-PiHoleBlocking` and `Disable-PiHoleBlocking` not properly managing sessions.

---

## [0.2.0] - 2025-04-10

### Added

* `Get-PiHoleStats` – Retrieves current Pi-hole usage and performance statistics (`GET /stats/summary`)
* `Get-PiHoleDomain` – Fetches domain lists from Pi-hole (`GET /domains`)

---

## [0.1.0] - 2025-04-01

### Initial Release

* Base module functionality for interacting with the Pi-hole v6 API.
* Implemented the following functions:

* `Get-PiHoleBlocking` (`GET /auth/sessions`)
* `Enable-PiHoleBlocking` (`POST /auth/sessions`)
* `Disable-PiHoleBlocking` (`POST /auth/sessions`)
* `Get-PiHoleHistory` (`GET /history`)
* `Get-PiHoleSummary` (`GET /stats/database/summary`)

---

> 📌 This changelog follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) principles.

FileList

Version History

Version	Downloads	Last updated
0.6.0 (current version)	1	8/11/2025
0.5.0	15	5/28/2025
0.4.0	8	5/23/2025
0.3.0	10	5/11/2025
0.2.2	6	5/10/2025
0.2.1	6	5/9/2025
0.2.0	5	5/9/2025
0.1.0	6	5/8/2025