Skip to main content
POST
Test Draft Scanner Delivery

Authorizations

x-api-key
string
header
required

API key for authentication (lowercase header name)

Body

application/json

Test an unsaved scanner. webhook_url is required for webhook/Discord tests. The response may include a generated webhook secret for preview.

scanner_type
enum<string>
required
Available options:
stealer,
breach
query_config
object
required

Persistent scanner search definition.

Scanners reuse the same flat filters and structured filter grammar as V2 search, but reject runtime-only params such as from, to, cursor, page_size, format, debug, and search_id. Scanner runs always execute on indexed_at.

Example:
notification_type
enum<string>
required
Available options:
email,
webhook,
discord
name
string
webhook_url
string
webhook_secret
string
webhook_security_mode
enum<string>

New webhook scanners should use signed_json or signed_encrypted.

Available options:
api_key,
signed_json,
signed_encrypted
notify_on_zero_results
boolean

Response

200 - application/json

Raw delivery-test response

success
boolean
notification_type
string
target
string
status_code
integer
message
string
preview
object
generated_webhook_secret
string