Tasks

Run a recon task against a domain, IP, or URL and read the result.

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/available

Tasks this key can run

Create a task

POST/v3/tasks

Create a task

FieldRequiredNotes
targetyesDomain, IP, or URL, depending on the task
taskyesA name returned by /tasks/available
callbacknoSee 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}/results

Task results

GET/v3/tasks

List tasks

The list defaults to limit 20 (max 1000). The task includes task_id, target, type, status, created_at, completed_at, and callback.