Skip to main content
POST
/
v1
/
asset
/
enumerate
Create Enumeration
curl --request POST \
  --url https://api.projectdiscovery.io/v1/asset/enumerate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "root_domains": [
    "<string>"
  ],
  "enrichment_inputs": [
    "<string>"
  ],
  "cloudlist_config_ids": [
    "<string>"
  ],
  "name": "<string>",
  "steps": [
    "dns_resolve"
  ],
  "enumeration_ports": "<string>",
  "alerting_config_ids": [
    "<string>"
  ],
  "disable_global_alert_config": true,
  "exclude_targets": [
    "<string>"
  ],
  "enumeration_config": {
    "follow-redirect": true,
    "ports": "<string>"
  },
  "automatic_vuln_scans": true,
  "per_domain_enumeration": true,
  "agent_id": "<string>",
  "agent_tags": [
    "<string>"
  ],
  "agent_networks": [
    "<string>"
  ],
  "agent_behavior": "distribute",
  "agent_auto_discover": true,
  "exclusions": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "truncated-scan-targets": 123,
  "is-public": true,
  "bulk_ids": [
    "<string>"
  ],
  "failed_domains": {}
}

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
​
root_domains
string[]
​
enrichment_inputs
string[]
​
cloudlist_config_ids
string[]
​
name
string
​
steps
enum<string>[]
Available options:
dns_resolve,
dns_bruteforce,
dns_permute,
port_scan,
http_probe,
http_screenshot,
endpoint_crawling,
dns_passive,
tls_scan,
uncover_assets,
dns_scraping
​
enumeration_ports
string
​
alerting_config_ids
string[]
​
disable_global_alert_config
boolean
​
exclude_targets
string[]
​
enumeration_config
object
​
automatic_vuln_scans
boolean
​
per_domain_enumeration
boolean
​
agent_id
string
​
agent_tags
string[]
​
agent_networks
string[]
​
agent_behavior
enum<string>
default:distribute
Available options:
distribute,
mirror
​
agent_auto_discover
boolean
​
exclusions
string[]

Combined inclusion and exclusion patterns for discovery scope. Exclusion patterns (e.g. *.staging.company.com) filter out matching targets. Inclusion patterns use a + prefix (e.g. +prod-*.company.com) to restrict discovery 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.

Response

OK

​
id
string
​
truncated-scan-targets
integer
​
is-public
boolean
​
bulk_ids
string[]
​
failed_domains
object

Map of domain to failure reason