Documentation
The Efflux API
Authenticate with an API key, then create scans, captures, surveys, and permutations. Each page shows the request, a working example, and the response.
API referenceGetting started
Discovery and scanning
ScansScan hosts, ports, domains, and URLs, then read results, summaries, and checks.ChecksRead vulnerability checks from your scans, filtered by severity or CVE.CapturesRender a URL and retrieve the screenshot, HTML, cookies, and network log.Domain SurveysSurvey a domain and build an asset map of subdomains and resolved hosts.Domain PermutationsGenerate Domain Permutations, resolve them, and read the report.TasksRun a recon task against a domain, IP, or URL and read the result.SearchLook up a domain or host, search your own results, or page through full-text search.
Automation
SchedulesRun a scan, survey, capture, or permutation check on a recurring frequency.Host and Port ListsSave reusable host and port lists and reference them by name from a scan.RulesTag scan and URL results when fields, headers, or cookies match a query.CallbacksSend an HTTPS request when a scan, capture, survey, or permutation starts, finishes, or fails.WebhooksBetaSave an endpoint, verify the signature, and review or retry deliveries.
Monitoring
Account and data
PreferencesStore UI settings, scan defaults, and the callbacks applied when a job leaves a phase empty.Limits and UsageRead the limits on your key and the usage recorded against your account.Reference DataLook up top ports, a CVE, and recently seen hosts and domains.StreamsSubscribe to scan progress over a WebSocket with the efflux.v1 subprotocol.