Create Scan

Trigger a scan

POST /v1/scans

Create Scan

cURL

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>"
  ]
}
'

import requests

url = "https://api.projectdiscovery.io/v1/scans"

payload = {
    "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>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>']
  })
};

fetch('https://api.projectdiscovery.io/v1/scans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.projectdiscovery.io/v1/scans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.projectdiscovery.io/v1/scans"

	payload := strings.NewReader("{\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"templates\": [\n    \"<string>\"\n  ],\n  \"assets\": [\n    \"<string>\"\n  ],\n  \"private_templates\": [\n    {\n      \"name\": \"<string>\",\n      \"contents\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"recommended\": true,\n  \"all\": true,\n  \"alerting_config_ids\": [\n    \"<string>\"\n  ],\n  \"scan_config_ids\": [\n    \"<string>\"\n  ],\n  \"reporting_config_ids\": [\n    \"<string>\"\n  ],\n  \"early_templates\": [\n    \"<string>\"\n  ],\n  \"exclude_targets\": [\n    \"<string>\"\n  ],\n  \"enumeration_ids\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"schedule_only\": true,\n  \"disable_global_alert_config\": true,\n  \"disable_global_report_config\": true,\n  \"disable_global_scan_config\": true,\n  \"socks5_proxy\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"agent_tags\": [\n    \"<string>\"\n  ],\n  \"agent_networks\": [\n    \"<string>\"\n  ],\n  \"agent_behavior\": \"distribute\",\n  \"automatic_scan\": true,\n  \"scan_all_assets\": true,\n  \"exclusions\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.projectdiscovery.io/v1/scans")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"templates\": [\n    \"<string>\"\n  ],\n  \"assets\": [\n    \"<string>\"\n  ],\n  \"private_templates\": [\n    {\n      \"name\": \"<string>\",\n      \"contents\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"recommended\": true,\n  \"all\": true,\n  \"alerting_config_ids\": [\n    \"<string>\"\n  ],\n  \"scan_config_ids\": [\n    \"<string>\"\n  ],\n  \"reporting_config_ids\": [\n    \"<string>\"\n  ],\n  \"early_templates\": [\n    \"<string>\"\n  ],\n  \"exclude_targets\": [\n    \"<string>\"\n  ],\n  \"enumeration_ids\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"schedule_only\": true,\n  \"disable_global_alert_config\": true,\n  \"disable_global_report_config\": true,\n  \"disable_global_scan_config\": true,\n  \"socks5_proxy\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"agent_tags\": [\n    \"<string>\"\n  ],\n  \"agent_networks\": [\n    \"<string>\"\n  ],\n  \"agent_behavior\": \"distribute\",\n  \"automatic_scan\": true,\n  \"scan_all_assets\": true,\n  \"exclusions\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.projectdiscovery.io/v1/scans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"templates\": [\n    \"<string>\"\n  ],\n  \"assets\": [\n    \"<string>\"\n  ],\n  \"private_templates\": [\n    {\n      \"name\": \"<string>\",\n      \"contents\": \"<string>\"\n    }\n  ],\n  \"name\": \"<string>\",\n  \"recommended\": true,\n  \"all\": true,\n  \"alerting_config_ids\": [\n    \"<string>\"\n  ],\n  \"scan_config_ids\": [\n    \"<string>\"\n  ],\n  \"reporting_config_ids\": [\n    \"<string>\"\n  ],\n  \"early_templates\": [\n    \"<string>\"\n  ],\n  \"exclude_targets\": [\n    \"<string>\"\n  ],\n  \"enumeration_ids\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"schedule_only\": true,\n  \"disable_global_alert_config\": true,\n  \"disable_global_report_config\": true,\n  \"disable_global_scan_config\": true,\n  \"socks5_proxy\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"agent_tags\": [\n    \"<string>\"\n  ],\n  \"agent_networks\": [\n    \"<string>\"\n  ],\n  \"agent_behavior\": \"distribute\",\n  \"automatic_scan\": true,\n  \"scan_all_assets\": true,\n  \"exclusions\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "id": "<string>",
  "truncated-scan-targets": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 123
}

{
  "message": "<string>",
  "kind": "<string>",
  "code": "<string>",
  "error": "<string>",
  "error_id": "<string>",
  "param": "<string>",
  "status": 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 · PrivateTemplates · object[]

Show child attributes

name · string

recommended · boolean

all · boolean

alerting_config_ids · string[]

scan_config_ids · string[]

reporting_config_ids · string[]

early_templates · string[]

exclude_targets · string[]

enumeration_ids · EnumerationIds · object[]

Show child attributes

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[]

Response

200

application/json

Example response

message · string · required

id · string

truncated-scan-targets · integer