Sign in
scans

Create Scan

Trigger a scan

post/v1/scans

Headers

X-Team-Idstring

Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team

Request body

targetsstring[]
templatesstring[]
assetsstring[]
namestring
recommendedboolean
allboolean
alerting_config_idsstring[]
scan_config_idsstring[]
reporting_config_idsstring[]
early_templatesstring[]
exclude_targetsstring[]
schedule_onlyboolean
disable_global_alert_configboolean
disable_global_report_configboolean
disable_global_scan_configboolean
socks5_proxystring
agent_idstring
agent_tagsstring[]
agent_networksstring[]
agent_behavior'distribute' | 'mirror'
automatic_scanboolean
scan_all_assetsboolean
exclusionsstring[]

Combined inclusion and exclusion patterns for scan scope. Exclusion patterns (e.g. *.staging.company.com) filter out matching targets. Inclusion patterns use a + prefix (e.g. +prod-*.company.com) to restrict scanning to only matching targets (allowlist mode). When inclusion patterns are present, targets must match at least one inclusion pattern and not match any exclusion pattern. Supports exact domains, wildcard patterns, IP addresses, and CIDR ranges.

Response

Example response

idstring
messagestring required
truncated-scan-targetsinteger

Changes