POST
/
v1
/
scans
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>",
      "type": [
        "<string>"
      ]
    }
  ],
  "schedule_only": true,
  "disable_global_alert_config": true,
  "disable_global_report_config": true,
  "disable_global_scan_config": true,
  "socks5_proxy": "<string>"
}'
{
  "id": "<string>",
  "message": "<string>",
  "truncated-scan-targets": 123
}

Authorizations

X-API-Key
string
header
required

Headers

X-Team-Id
string

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

Body

application/json
targets
string[]
templates
string[]
assets
string[]
private_templates
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
object[]
schedule_only
boolean
disable_global_alert_config
boolean
disable_global_report_config
boolean
disable_global_scan_config
boolean
socks5_proxy
string

Response

200
application/json
Example response
message
string
required
id
string
truncated-scan-targets
integer