Pihole Denylist

@sntxrr/pihole-denylistv2026.09.27.1· 9d agoMODELS

01README

Declare a Pi-hole v6 exact-deny list in swamp and converge an appliance to it: plan by default, apply on request, prune only when asked

02Models1

@sntxrr/pihole-denylistv2026.09.27.1pihole_denylist.ts

Argument	Type	Required	Description
host	string	yes	Pi-hole host, e.g. 192.0.2.53 or dns.example.lan:8080 (a scheme may be included)
password	string	yes	Pi-hole web/app password; use a vault reference
scheme	enum	yes	URL scheme when host carries none
caCert?	string	no	Inline PEM CA certificate for a self-signed HTTPS appliance
domains	array	yes	Declared exact-deny domains (hostnames only; normalised to lower case, de-duplicated)
comment	string	yes	Comment written on entries this model adds or re-enables
groups	array	yes	Pi-hole group ids for added entries (0 = Default)

fn list()

Read the appliance's exact-deny list (read-only)

fn converge(dryRun: boolean, prune: boolean, maxRemovals: number)

Converge the exact-deny list to globalArguments.domains. Plans only unless dryRun=false; removes undeclared entries only with prune=true.

Argument	Type	Required	Description
dryRun	boolean	yes	Plan only (default). Set false to apply the changes.
prune	boolean	yes	Remove exact-deny entries on the appliance that are not declared
maxRemovals	number	yes	Refuse a prune that would remove more than this many entries

deny-list(infinite)— The appliance's exact-deny entries at the time of reading

converge-result(infinite)— What a converge planned and (unless dryRun) applied, with any failures

03Stats

100 / 100

Downloads

Archive size

10.1 KB

Repository

04Platforms

05Labels