aid: pi-hole
name: Pi-hole
description: >-
  Pi-hole is an open source network-wide DNS sinkhole that blocks ads, tracking,
  and unwanted domains across all devices on a local network without requiring
  per-device software. It runs on lightweight hardware such as Raspberry Pi and
  offers a web admin interface plus a REST API (introduced in v6 via the
  pihole-FTL binary) for programmatic management of blocklists, allowlists,
  groups, clients, DNS settings, and live query logs.
type: Index
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: medium
  source:
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/pi-hole.png
tags:
  - DNS
  - Ad Blocking
  - Network Security
  - Privacy
  - Open Source
  - Self-Hosted
url: >-
  https://raw.githubusercontent.com/api-evangelist/pi-hole/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-05-11'
specificationVersion: '0.19'
apis:
- aid: pi-hole:pi-hole-auth-api
  name: Pi-hole Auth API
  description: Session authentication.
  humanURL: https://docs.pi-hole.net/api/
  baseURL: http://pi.hole/api
  tags:
  - Auth
  properties:
  - type: OpenAPI
    url: openapi/pi-hole-auth-api-openapi.yml
  - type: Documentation
    url: https://docs.pi-hole.net/api/
  - type: Authentication
    url: https://docs.pi-hole.net/api/auth/
- aid: pi-hole:pi-hole-dns-api
  name: Pi-hole DNS API
  description: DNS blocking configuration.
  humanURL: https://docs.pi-hole.net/api/
  baseURL: http://pi.hole/api
  tags:
  - DNS
  properties:
  - type: OpenAPI
    url: openapi/pi-hole-dns-api-openapi.yml
  - type: Documentation
    url: https://docs.pi-hole.net/api/
  - type: Authentication
    url: https://docs.pi-hole.net/api/auth/
- aid: pi-hole:pi-hole-groups-api
  name: Pi-hole Groups API
  description: Manage DNS blocking groups.
  humanURL: https://docs.pi-hole.net/api/
  baseURL: http://pi.hole/api
  tags:
  - Groups
  properties:
  - type: OpenAPI
    url: openapi/pi-hole-groups-api-openapi.yml
  - type: Documentation
    url: https://docs.pi-hole.net/api/
  - type: Authentication
    url: https://docs.pi-hole.net/api/auth/
- aid: pi-hole:pi-hole-info-api
  name: Pi-hole Info API
  description: Pi-hole instance information.
  humanURL: https://docs.pi-hole.net/api/
  baseURL: http://pi.hole/api
  tags:
  - Info
  properties:
  - type: OpenAPI
    url: openapi/pi-hole-info-api-openapi.yml
  - type: Documentation
    url: https://docs.pi-hole.net/api/
  - type: Authentication
    url: https://docs.pi-hole.net/api/auth/
common:
  - type: AgenticAccess
    url: agentic-access/pi-hole-agentic-access.yml
  - type: DomainSecurity
    url: security/pi-hole-domain-security.yml
  - type: Authentication
    url: authentication/pi-hole-authentication.yml
  - type: LinkedIn
    url: https://www.linkedin.com/company/the-pi-hole
  - type: Website
    url: https://pi-hole.net
  - type: Documentation
    url: https://docs.pi-hole.net
  - type: GitHubOrganization
    url: https://github.com/pi-hole
  - type: Source Code
    url: https://github.com/pi-hole/pi-hole
  - type: FTL Source
    url: https://github.com/pi-hole/FTL
  - type: Discourse Forum
    url: https://discourse.pi-hole.net
  - type: Donate
    url: https://pi-hole.net/donate/
  - type: Blog
    url: https://pi-hole.net/blog/
maintainers:
  - FN: Kin Lane
    email: kin@apievangelist.com