HaveIBeenPwned
The haveibeenpwned sensor integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] creates sensors that check for breached email accounts on haveibeenpwned
Configuration
In order to use this integration you need to purchase an API key. Visit the API key page
Configuration
To enable this sensor, add the following lines to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. It will list every specified email address as a sensor showing the number of breaches on that email account.
After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.
# Example configuration.yaml entry using cloud based emoncms
sensor:
- platform: haveibeenpwned
email:
- [email protected]
- [email protected]
api_key: API_KEY
Breach meta data
If one of your email accounts is breached the sensor will display breach meta data. It will list the title of the site where your email
account has been breached as well as the added date of the breach data. This data is displayed in descending order so that the state attribute
breach 1 will always contain the last known breach for the specific email account, if there are any breaches detected.
The sensor will scan all email addresses specified with a 5 second delay between all breach data requests on Home Assistant startup. After this initial startup scanning, the sensor will only scan one email account per 15 minutes to prevent abuse, and not hammer “the Have I been Pwned” service, as this breach data almost never changes.