Configuration
Every module setting, its default and what it does, generated from the module itself.
Module settings live in the WHMCS admin under Configuration → Addon Modules → Aegis Security Monitoring → Configure.
| Setting | Type | Default | What it does |
|---|---|---|---|
Aegis API URL (api_url) | text | https://portal.aegiswhite.com | The base URL for the Aegis API (e.g., https://portal.aegiswhite.com) |
API Key (api_key) | password | — | Your Aegis API key for authentication |
Debug Mode (debug_mode) | yesno | no | Enable verbose logging for troubleshooting |
BCC Admin on Customer Actions (bcc_admin_emails) | yesno | no | Send a copy of customer action confirmation emails to the system admin email address |
Sandbox Mode (sandbox_mode) | yesno | yes | Enable sandbox mode for testing. No real scans will be performed. |
Sandbox Scenario (sandbox_scenario) | one of: warnings, clean, critical | warnings | Select the mock scan result scenario for testing (warnings = web ports, clean = no issues, critical = database ports) |
Customer Upgrade URL (upgrade_url) | text | — | URL where customers are directed to upgrade their plan (e.g., your WHMCS cart URL). Leave blank for default message. |
Endpoint Creation Mode (endpoint_creation_mode) | one of: any, whmcs_only | any | Controls whether customers can add any IP/hostname or only IPs from their active WHMCS products |
Domain Monitoring Learn More URL (domain_learn_more_url) | text | — | URL shown on the "Domain Monitoring is not active" page (e.g., a marketing or docs page). Leave blank to hide the button entirely. |
The two settings that matter most
Aegis API URL must be your portal domain, the same domain your customers use. Your API key is bound to that domain; pointing the module at a different portal host fails with TENANT_MISMATCH.
API Key comes from your portal under Settings → WHMCS Integration. It is revealed once when generated. If you lose it, regenerate (the old key stops working immediately).
Sandbox Mode ships enabled so new installs cannot trigger real scans by accident. Turn it off when you go live. While it is on, provisioning is simulated and customers see mock scan data.