🔑 Getting the API token (v5 only)

This guide explains how to get the API token to authenticate the application with your Pi-hole server.

info

This process applies only to Pi-hole server version 5.x.

If you are using Pi-hole version 6.x, authentication is handled differently and does not require an API token.

1. Go to the admin panel of your Pi-hole® server and log in.

   

2. On the side menu, go to Settings.

   

3. Go to API / Web interface.

   

4. Click on Show API token.

   

5. Click on Yes, show API token.

   

6. On the application, tap the QR code button (1) and then, scan the QR code, or copy the API token (text under the QR code) and paste it into the Token field (2).