Prometheus/OpenMetrics endpoint

[DL6ER]

Documentation for pi-hole/FTL#2943, which adds a native Prometheus/OpenMetrics scrape endpoint at GET /api/metrics. This is the documentation PR @yubiuser asked for in pi-hole/FTL#2943 (comment).

To be merged with the release of v7.0 - docs.pi-hole.net serves master directly, so these pages must not go live before pi-hole/FTL#2943 ships.

[netlify]

✅ Deploy Preview for pihole-docs ready!

Name	Link
🔨 Latest commit	631896b
🔍 Latest deploy log	https://app.netlify.com/projects/pihole-docs/deploys/6a78062d1beb34000801c5a8
😎 Deploy Preview	https://deploy-preview-1415--pihole-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Copilot]

Pull request overview

Adds Pi-hole API documentation for the new native Prometheus/OpenMetrics scrape endpoint (GET /api/metrics) introduced in pi-hole/FTL#2943, and wires the new page into the MkDocs navigation.

Changes:

• Add a new API documentation page describing enabling, authenticating, scraping, and configuring the Prometheus/OpenMetrics endpoint.
• Add the new “Metrics” page to the MkDocs nav under “Pi-hole API”.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
mkdocs.yml	Adds the new “Metrics” page to the “Pi-hole API” navigation section.
docs/api/prometheus.md	New documentation page for the Prometheus/OpenMetrics metrics endpoint, including auth model, config options, exported metrics, and example scrape config.

Suppressed comments (3)

docs/api/prometheus.md:120

• Use "256-bit" (hyphenated compound modifier) here as well for consistency and correct grammar.

The response is identical for a missing and for an incorrect token, and tokens are compared in constant time. As the token is a 256 bit random value, no rate limiting is applied to this endpoint.

docs/api/prometheus.md:79

• This curl example uses a concrete bearer token value. Prefer a placeholder (e.g., <scrape_token>) so readers don’t accidentally reuse the doc token and to avoid secret-scanning false positives in docs.

        curl -k "https://pi.hole/api/metrics" -H "Authorization: Bearer 7ua0rHPZixX6B3bTa5o4Dv08iyEIm/2q9qgLrF9MNVw="

docs/api/prometheus.md:88

• This Python example hardcodes a concrete bearer token value. Prefer a placeholder (e.g., <scrape_token>) so readers don’t accidentally reuse the doc token and to avoid secret-scanning false positives in docs.

        headers = {"Authorization": "Bearer 7ua0rHPZixX6B3bTa5o4Dv08iyEIm/2q9qgLrF9MNVw="}

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.