Domain Permutations

What a permutation check is

A permutation check generates Domain Permutations for one domain, resolves them, and writes a report. Status values are pending, in progress, complete, and failed.

POST/v3/permutations

Create a permutation check

API reference

Request fields

Field	Required	Notes
`domain`	yes	Apex domain to permute
`callback`	no	See Callbacks. Empty phases can be filled from preferences

curl -sS -X POST "https://api.efflux.io/v3/permutations" \
  -H "Authorization: Bearer $EFFLUX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example.com",
    "callback": {
      "success": { "url": "https://example.com/hook/$job_id", "method": "POST" }
    }
  }'

The response data includes check_id, domain, status, created_at, permutation_count, dns_record_count, and callback. report_generated_at is set when the report exists.

Read the report

GET/v3/permutations/{check_id}

Get a check

API reference

GET/v3/permutations/{check_id}/lists

Generated name lists

API reference

GET/v3/permutations/{check_id}/report

Resolved permutations

API reference

GET/v3/permutations

List checks

API reference

The list accepts check_id, domain, and status, plus page and limit (default 100, max 1000).

The report adds domain_dns, permutation_count_by_type, and permutations_dns. Wait until status is complete and report_generated_at is set before reading it.

Permutation checks are daily or slower when placed on a schedule.