List Leak Detection API

API link: Explore API

Add trusted domains

There are two ways to add trusted domains

  1. Bulk API: https://api-doc.emailconsul.com/post-honeytoken-trusted-domains-add-bulk

    Send an array of domain values. Each entry can be a plain domain (e.g. example.com) or a wildcard (e.g. *.example.com) to match the domain itself and all its subdomains.

  2. Import CSV: https://api-doc.emailconsul.com/post-honeytoken-trusted-domains-import

    CSV must contain a "domain" column. Wildcards are also supported in CSV.

Both methods are upserting your trusted domains, which means that if a domain is already added, it will not be added again, preventing duplication.

Get trusted domains

To retrieve the list of trusted domains, use the API https://api-doc.emailconsul.com/get-honeytoken-trusted-domains. This API returns the list of trusted domains with all related info.

Response item description:

Delete trusted domain

To delete a trusted domain, use the API https://api-doc.emailconsul.com/delete-honeytoken-trusted-domains-by-id.

Get logs

To retrieve List Leak Detection log entries, use the API https://api-doc.emailconsul.com/get-honeytoken-logs. This API returns the list of log entries with all related info.

Response item description:

Get aggregated stats

To get aggregated stats for List Leak Detection, use APIs:

By domain: https://api-doc.emailconsul.com/get-honeytoken-stats-aggregated-domain

By sender: https://api-doc.emailconsul.com/get-honeytoken-stats-aggregated

Pass group=from_email to group results by sender email address.

By recipient: https://api-doc.emailconsul.com/get-honeytoken-stats-aggregated

Pass group=to_email to group results by recipient email address.

Get timeseries stats

To get timeseries stats for List Leak Detection, use API https://api-doc.emailconsul.com/get-honeytoken-stats-timeseries. This API returns daily stats of list leak hits for the specified period.

Export workers

To export the list leak detection workers assigned to your account as a CSV file, use the API https://api-doc.emailconsul.com/get-honeytoken-workers-export.

Get workers stats

To retrieve the count of active list leak detection workers , use the API https://api-doc.emailconsul.com/get-honeytoken-workers-stats. This API returns the count of active workers assigned to your account grouped by worker host.