For the complete documentation index, see llms.txt. This page is also available as Markdown.

Lucy Security

Connection Requirements

1 - IP

The host of your Lucy Security appliance, for example phish.local or your-lucy-url.tld.

2 - Port

Port number (optional, default: 443).

3 - Is Secure

Choose this if your connection is going to be over HTTPS (optional, default: True).

4 - Email

The login email used to sign in to the Lucy appliance. This is the same account used to authenticate against POST /api/auth.

5 - Password

The password of that account.

Lucy Security authenticates with the same email and password used to log in to the Lucy appliance. The account must have permission to read recipients and recipient groups, since these are the endpoints used to collect user data.

6 - Proxy

Proxy URL (optional).

7 - Timeout

The amount of time (in seconds) to wait for API responses. (default: 30)

Last updated