Web Interface - API Settings

Theme settings

Theme:

Use the boxed layout

The boxed layout is helpful when working on large screens because it prevents the site from stretching very wide.

Advanced Settings

Prettify API output for human-readability

This will make the API output more human-readable, but will increase the size of the output and make the API a bit slower.

Permit destructive actions via API

This will allow clients to perform destructive actions via the API, such as rebooting or shutting down the system Pi-hole is running on.

Exclusions

Domains to be excluded from Top Domain Lists and Query Log

Domains may be described by their domain name (like ^example\.com$)

Clients to be excluded from Top Client Lists and Query Log

Clients may be described either by their IP addresses (IPv4 and IPv6 are supported), or hostnames (like ^laptop\.lan$).

Important:
Those input fields accept regex entries only.
Please refer to our guide how to construct valid regex entries.

Currently active sessions

	ID	Valid	TLS			Login at	Valid until	Client IP	User Agent

Enable two-factor authentication

Use a phone app like Google Authenticator, 2FA Authenticator, FreeOTP or BitWarden, etc. to get 2FA codes when prompted during login.

1. Scan the QR code below with your app or enter the secret manually.

2. Enter the 2FA code from your app below to confirm that you have set up 2FA correctly.

IMPORTANT: If you lose your 2FA token, you will not be able to login. You will need to disable 2FA on the command line and re-enable 2FA to generate a new secret.

Configure application password

After you turn on two-factor (2FA) verification and set up an Authenticator app, you may run into issues if you use apps or other services that don't support two-step verification. In this case, you can create and use an app password to sign in.

An app password is a long, randomly generated password that can be used instead of your regular password + 2FA token when signing in to the API. You can revoke the app password at any time. The app password can also be used when 2FA is not enabled.

🔐
Your new app password is:

IMPORTANT: The app password generated here will only be shown once and cannot be recovered. Make sure to store it in a safe place!

Application password already configured

Enabling the new app password will forcefully log out all existing applications.