What you need
The API base URL is https://api.efflux.io/v3. Every request sends your API key in the Authorization header. A Bearer prefix is optional.
Create the key in the app: open your profile and choose API Keys. An API key cannot create or manage other keys. See API Keys.
First request
GET /limits returns the quotas on the key you just sent. It is a small authenticated call that confirms the header, the base URL, and that the key is active.
/v3/limitsLimits for the current key
curl -sS "https://api.efflux.io/v3/limits" \
-H "Authorization: Bearer $EFFLUX_TOKEN"A successful body puts the resource in data and a links.self URL beside it. The response shape is covered in API Conventions.
What to do next
- Scans for hosts, ports, domains, and URLs.
- Captures for a rendered page, screenshot, cookies, and network log.
- Domain Surveys for an asset map of a domain.
- Domain Permutations for generated domain names.
To hear when a scan, capture, survey, or permutation starts or finishes, attach a callback or a saved webhook. Save that destination once under preferences and later jobs can pick it up when the request leaves the phase empty.