What a survey is
A domain survey discovers subdomains, resolves them, and builds an asset map. Status values are pending, in progress, complete, and error.
POST
/v3/assetmaps/surveysCreate a domain survey
Request fields
| Field | Required | Notes |
|---|---|---|
domain | yes | Apex domain to survey |
tracked_subdomains | no | Subdomains that are always resolved, even if discovery misses them |
callback | no | See Callbacks. Empty phases can be filled from preferences |
curl -sS -X POST "https://api.efflux.io/v3/assetmaps/surveys" \
-H "Authorization: Bearer $EFFLUX_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"domain": "example.com",
"tracked_subdomains": ["vpn", "mail"],
"callback": {
"success": { "callback_id": "whook_abc123" }
}
}'callback_id is the id of a saved webhook. You can send a raw url instead.
Read the survey and the map
GET
/v3/assetmaps/surveys/{survey_id}Get a survey
GET
/v3/assetmaps/surveys/{survey_id}/mapAsset map for a finished survey
GET
/v3/assetmaps/surveysList surveys
The list accepts survey_id and domain, plus page and limit (default 20, max 1000).
The survey includes survey_id, domain, tracked_subdomains, subdomains_checked, dns_ips, status, timestamps, and callback. Fetch the map after status is complete.
Surveys are slow. Weekly or slower is the floor when you put one on a schedule.