Skip to main content
POST
/
v1
/
scans
Create Scan
curl --request POST \
  --url https://api.projectdiscovery.io/v1/scans \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "targets": [
    "<string>"
  ],
  "templates": [
    "<string>"
  ],
  "assets": [
    "<string>"
  ],
  "private_templates": [
    {
      "name": "<string>",
      "contents": "<string>"
    }
  ],
  "name": "<string>",
  "recommended": true,
  "all": true,
  "alerting_config_ids": [
    "<string>"
  ],
  "scan_config_ids": [
    "<string>"
  ],
  "reporting_config_ids": [
    "<string>"
  ],
  "early_templates": [
    "<string>"
  ],
  "exclude_targets": [
    "<string>"
  ],
  "enumeration_ids": [
    {
      "id": "<string>"
    }
  ],
  "schedule_only": true,
  "disable_global_alert_config": true,
  "disable_global_report_config": true,
  "disable_global_scan_config": true,
  "socks5_proxy": "<string>",
  "agent_id": "<string>",
  "agent_tags": [
    "<string>"
  ],
  "agent_networks": [
    "<string>"
  ],
  "agent_behavior": "distribute",
  "automatic_scan": true,
  "scan_all_assets": true,
  "exclusions": [
    "<string>"
  ],
  "asset_filters": {
    "is_tech": true,
    "is_favicon": true,
    "is_new": true,
    "labels": "<string>",
    "host": "<string>",
    "port": "<string>",
    "status_code": "<string>",
    "content_length": "<string>",
    "title": "<string>",
    "domain": [
      "<string>"
    ],
    "cname": "<string>",
    "technologies": "<string>",
    "ip": "<string>",
    "is_screenshot": true,
    "time": "last_day",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "custom_filter": "<string>",
    "search": "<string>",
    "enumeration_ids": [
      "<string>"
    ],
    "only_dns": true,
    "only_ip": true
  }
}
'
{
  "message": "<string>",
  "id": "<string>",
  "truncated-scan-targets": 123
}

Authorizations

X-API-Key
string
header
required

Headers

X-Team-Id
string

Body

application/json
targets
string[]
templates
string[]
assets
string[]
private_templates
PrivateTemplates · object[]
name
string
all
boolean
alerting_config_ids
string[]
scan_config_ids
string[]
reporting_config_ids
string[]
early_templates
string[]
exclude_targets
string[]
enumeration_ids
EnumerationIds · object[]
schedule_only
boolean
disable_global_alert_config
boolean
disable_global_report_config
boolean
disable_global_scan_config
boolean
socks5_proxy
string
agent_id
string
agent_tags
string[]
agent_networks
string[]
agent_behavior
enum<string>
default:distribute
Available options:
distribute,
mirror
automatic_scan
boolean
scan_all_assets
boolean
exclusions
string[]

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.

asset_filters
AssetFilters · object

Response

Example response

message
string
required
id
string
truncated-scan-targets
integer