On GitHub, pi-hole/api has picked up 170 stars, Rust. The Pi-hole API
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
This repository has been archived. For more information please see https://github.com/pi-hole/FTL/pull/659
Pi-hole API
Work in progress HTTP API for Pi-hole.
The API reads FTL's shared memory so it can directly read the statistics FTL
generates. This API is the replacement for most of FTL's socket/telnet API, as
well as the PHP API of the pre-5.0 web interface.
Currently the project uses Rust nightly. The exact version used is stored
in rust-toolchain. The version should be detected and
used automatically when you run a Rust command in the project directory,
such as cargo check (this is a feature of rustup)
After installing, make sure the Rust tools are on your PATH:
source ~/.cargo/env
Install your distro's build tools
build-essential for Debian distros, gcc-c++ and make for RHEL
distros
Install libsqlite3
libsqlite3-dev for Debian distros, sqlite-devel for RHEL
Fork the repository and clone to your computer (not the Pi-hole). In
production the Pi-hole only needs the compiled output of the project, not its
source code
Checkout the development branch for the latest changes.
Run cargo check. This will download the Rust nightly toolchain and project
dependencies, and it will check the program for errors. If everything was set
up correctly, the final output should look like this:
Finished dev [unoptimized + debuginfo] target(s) in 1m 11s
Run cargo test. This will compile and run the tests. They should all pass
:wink:
If you've never used Rust, you should look at the documentation,
including the Rust Book, before diving too deep into the code.
When you are ready to make changes, make a branch off of development in your
fork to work in. When you're ready to make a pull request, base the PR against
development.
No homepage URL was recorded for pi-hole/api in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How active is development on pi-hole/api?
The most recent commit recorded on pi-hole/api was 6.7 years ago, based on the GitHub push timestamp. The repository has 22 forks — one of the better signals of community interest.
How many stars does pi-hole/api have?
pi-hole/api has 170 GitHub stars — refresh the page for the live number, or check github.com/pi-hole/api. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is pi-hole/api open source?
TopGit's metadata for pi-hole/api does not record a license. Most public repositories on GitHub ARE open source, but the exact terms vary — verify by opening the LICENSE file directly.
What topics is pi-hole/api associated with?
GitHub's repository topics for pi-hole/api: "pi-hole". TopGit's editorial category is open-source.
Where do I read more about pi-hole/api?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/pi-hole/api is the definitive source.
Read full README in the tab above.
Want a second opinion on api?
Ask an AI that can read this page — one click and you get its take on api.