PiHole

Pi-hole is a network-level advertisement and Internet tracker blocking application which acts as a DNS sinkhole and optionally a DHCP server, intended for use on a private network.

IT Services · PiHole

Configuration parameters

  • url — Server URL (required)
  • token — Auth Token
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (21)

  • pihole-disable

    used to disable pihole for certain amount of time

  • pihole-enable

    Enable Pi-hole ad blocking

  • pihole-get-all-queries

    Get DNS queries data

  • pihole-get-cache-info

    Show cache info

  • pihole-get-client-names

    Get client names

  • pihole-get-forward-destinations

    Shows number of queries that have been forwarded and the target

  • pihole-get-list

    Get all available lists from Pihole

  • pihole-get-over-time-data-clients

    Get over time data clients

  • pihole-get-overTimeDataQueryTypes

    Get data over time per query types

  • pihole-get-overtimedata10mins

    Data needed for generating the domains/ads over time graph on the Pi-hole web dashboard

  • pihole-get-query-types

    Shows number of queries that the Pi-hole’s DNS server has processed

  • pihole-get-recent-blocked

    Show most recent blocked domain

  • pihole-get-summaryraw

    Gives statistics in raw format (no number formatting applied)

  • pihole-get-topclients

    Data needed for generating the Top Clients list

  • pihole-get-topclientsblocked

    Shows the top clients being blocked

  • pihole-get-topitems

    Data needed for generating the Top Domain and Top Advertisers Lists

  • pihole-get-type

    Returns the backend used by the API (either PHP or FTL)

  • pihole-get-version

    Returns the version of the API

  • pihole-get-versions

    Show versions of all components

  • pihole-list-management

    Manage lists. Add or remove items from lists

  • pihole-status

    Show status of pihole action (enabled - disabled)