Scans

Scans are the workhorse of the Console API. Submit one with a domain_id, a keyword set, and a platform list, and credits are debited up front against your balance. Preview lets you compute the exact cost of a payload before submitting, so you can gate the decision in your own UI. Once submitted, scans progress through queued, running, and a terminal state; fetch by id to inspect status and results, or cancel while still in flight.

Submission write endpoints accept an Idempotency-Key header; replaying the same key returns the original response rather than double-charging. See Scan triggering for the full payload walkthrough.

curl -X GET "https://example.com/scans?domain_id=string" \
  -H "X-API-Key: string"

null

curl -X POST "https://example.com/scans" \
  -H "X-API-Key: string" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

null

curl -X POST "https://example.com/scans/preview" \
  -H "X-API-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

null

curl -X GET "https://example.com/scans/string" \
  -H "X-API-Key: string"

null

curl -X POST "https://example.com/scans/string/cancel" \
  -H "X-API-Key: string"

null