Skip to main content
GET
/
v1
/
scans
/
{scan_id}
/
config
Get Scan Config
curl --request GET \
  --url https://api.projectdiscovery.io/v1/scans/{scan_id}/config \
  --header 'X-API-Key: <api-key>'
{
  "targets": [
    "<string>"
  ],
  "assets_lists": [
    "<string>"
  ],
  "public_templates": [
    "<string>"
  ],
  "early_templates": [
    "<string>"
  ],
  "template_urls": [
    "<string>"
  ],
  "template_ids": [
    "<string>"
  ],
  "scan_config_ids": [
    {
      "id": "<string>",
      "name": "<string>",
      "provider_name": "<string>",
      "config_type": "<string>"
    }
  ],
  "report_config_ids": [
    {
      "id": "<string>",
      "name": "<string>",
      "provider_name": "<string>",
      "config_type": "<string>"
    }
  ],
  "alerting_config_ids": [
    {
      "id": "<string>",
      "name": "<string>",
      "provider_name": "<string>",
      "config_type": "<string>"
    }
  ],
  "enumeration_ids": [
    {
      "id": "<string>",
      "name": "<string>",
      "total_assets": 123,
      "enumeration_type": "<string>",
      "cloudlist_provider_name": "<string>",
      "types": [
        "hosts"
      ]
    }
  ],
  "socks5_proxy": "<string>",
  "agent_id": "<string>",
  "agent_tags": [
    "<string>"
  ],
  "agent_networks": [
    "<string>"
  ],
  "agent_behavior": "distribute",
  "scan_all_assets": true
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Team-Id
string

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

Path Parameters

​
scan_id
string
required

Response

OK

​
targets
string[]
​
assets_lists
string[]
​
public_templates
string[]
​
early_templates
string[]
​
template_urls
string[]
​
template_ids
string[]
​
scan_config_ids
ScanConfigItem · object[]
​
report_config_ids
ScanConfigItem · object[]
​
alerting_config_ids
ScanConfigItem · object[]
​
enumeration_ids
EnumerationIDTypesDetail · object[]
​
socks5_proxy
string
​
agent_id
string
​
agent_tags
string[]
​
agent_networks
string[]
​
agent_behavior
enum<string>
default:distribute
Available options:
distribute,
mirror
​
scan_all_assets
boolean