API Reference
- Introduction
- Assets
- Templates
- Scans
- GETGet Scan List
- POSTCreate Scan
- GETGet Scan
- DELDelete Scan
- DELDelete Bulk Scans
- PATCHUpdate Scan
- POSTImport OSS Scan
- POSTStop Scan
- POSTRescan scan
- GETGet All Scan Stats
- POSTRetest vulnerability
- GETGet Scan Schedules
- POSTSet Scan Schedule
- DELDelete Scan Schedule
- GETGet Scan IPs
- PATCHUpdate Imported Scan
- GETExport Scan
- POSTExport Filtered Scan
- GETExport Scan Vulnerability
- DELDelete Scan Vulnerability
- PATCHUpdate Vulnerability Status
- PATCHUpdate Vulnerability Labels
- GETGet Scan Config
- PATCHUpdate Scan Config
- GETGet All Scans History
- GETGet Scan History
- POSTCreate vulns export to tracker
- GETGet Scans Token
- GET
- Configurations
- Results
- Logs
- Users
Scans
Create Scan
Trigger a scan
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
Headers
Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team
Body
application/json
Response
200
application/json
Example response
The response is of type object
.
Was this page helpful?
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
}