What a task is
A task runs one recon task against a single target. Call GET /tasks/available first and use a name from that list.
GET
/v3/tasks/availableTasks this key can run
Create a task
POST
/v3/tasksCreate a task
| Field | Required | Notes |
|---|---|---|
target | yes | Domain, IP, or URL, depending on the task |
task | yes | A name returned by /tasks/available |
callback | no | See Callbacks. Saved preferences are not applied |
curl -sS "https://api.efflux.io/v3/tasks/available" \
-H "Authorization: Bearer $EFFLUX_TOKEN"
curl -sS -X POST "https://api.efflux.io/v3/tasks" \
-H "Authorization: Bearer $EFFLUX_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"target": "example.com",
"task": "whois"
}'task must be a name from GET /tasks/available for the key you are using.
Status values are pending, complete, and failed.
Read results
GET
/v3/tasks/{task_id}Get a task
GET
/v3/tasks/{task_id}/resultsTask results
GET
/v3/tasksList tasks
The list defaults to limit 20 (max 1000). The task includes task_id, target, type, status, created_at, completed_at, and callback.