> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Have I Been Pwned

> Reference for the Tracecat Have I Been Pwned integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Check email for breaches

Action ID: `tools.hibp.check_email_breaches`

Check if an email address has been compromised in known data breaches.

Reference: [https://haveibeenpwned.com/API/v3#BreachesForAccount](https://haveibeenpwned.com/API/v3#BreachesForAccount)

### Secrets

Required secrets:

* `hibp`: required values `HIBP_API_KEY`.

### Input fields

<ParamField path="email" type="string" required>
  Email address to check for breaches.
</ParamField>

<ParamField path="domain_filter" type="string | null">
  Filter results to only breaches from this domain.

  Default: `null`.
</ParamField>

<ParamField path="include_unverified" type="boolean">
  Include unverified breaches in results.

  Default: `true`.
</ParamField>

<ParamField path="truncate_response" type="boolean">
  Return only breach names (True) or full breach details (False).

  Default: `true`.
</ParamField>

## Check email for pastes

Action ID: `tools.hibp.check_email_pastes`

Check if an email address has been found in any pastes.

Reference: [https://haveibeenpwned.com/API/v3#PastesForAccount](https://haveibeenpwned.com/API/v3#PastesForAccount)

### Secrets

Required secrets:

* `hibp`: required values `HIBP_API_KEY`.

### Input fields

<ParamField path="email" type="string" required>
  Email address to check for pastes.
</ParamField>

## Get all breaches

Action ID: `tools.hibp.get_all_breaches`

Get a list of all data breaches in the system.

Reference: [https://haveibeenpwned.com/API/v3#AllBreaches](https://haveibeenpwned.com/API/v3#AllBreaches)

### Input fields

<ParamField path="domain_filter" type="string | null">
  Filter breaches to only those affecting this domain.

  Default: `null`.
</ParamField>

## Get breach details

Action ID: `tools.hibp.get_breach_details`

Get detailed information about a specific data breach.

Reference: [https://haveibeenpwned.com/API/v3#SingleBreach](https://haveibeenpwned.com/API/v3#SingleBreach)

### Input fields

<ParamField path="breach_name" type="string" required>
  Name of the breach to get details for.
</ParamField>

## Get data classes

Action ID: `tools.hibp.get_data_classes`

Get all data classes in the system.

Reference: [https://haveibeenpwned.com/API/v3#DataClasses](https://haveibeenpwned.com/API/v3#DataClasses)

### Input fields

This action does not take input fields.

## Get latest breach

Action ID: `tools.hibp.get_latest_breach`

Get the most recently added breach in the system.

Reference: [https://haveibeenpwned.com/API/v3#LatestBreach](https://haveibeenpwned.com/API/v3#LatestBreach)

### Input fields

This action does not take input fields.