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": [],
"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>"
]
}
'import requests
url = "https://api.projectdiscovery.io/v1/asset/enumerate"
payload = {
"root_domains": ["<string>"],
"enrichment_inputs": ["<string>"],
"cloudlist_config_ids": ["<string>"],
"name": "<string>",
"steps": [],
"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>"]
}
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({
root_domains: ['<string>'],
enrichment_inputs: ['<string>'],
cloudlist_config_ids: ['<string>'],
name: '<string>',
steps: [],
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>']
})
};
fetch('https://api.projectdiscovery.io/v1/asset/enumerate', 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/asset/enumerate",
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([
'root_domains' => [
'<string>'
],
'enrichment_inputs' => [
'<string>'
],
'cloudlist_config_ids' => [
'<string>'
],
'name' => '<string>',
'steps' => [
],
'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>'
]
]),
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/asset/enumerate"
payload := strings.NewReader("{\n \"root_domains\": [\n \"<string>\"\n ],\n \"enrichment_inputs\": [\n \"<string>\"\n ],\n \"cloudlist_config_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"steps\": [],\n \"enumeration_ports\": \"<string>\",\n \"alerting_config_ids\": [\n \"<string>\"\n ],\n \"disable_global_alert_config\": true,\n \"exclude_targets\": [\n \"<string>\"\n ],\n \"enumeration_config\": {\n \"follow-redirect\": true,\n \"ports\": \"<string>\"\n },\n \"automatic_vuln_scans\": true,\n \"per_domain_enumeration\": true,\n \"agent_id\": \"<string>\",\n \"agent_tags\": [\n \"<string>\"\n ],\n \"agent_networks\": [\n \"<string>\"\n ],\n \"agent_behavior\": \"distribute\",\n \"agent_auto_discover\": 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/asset/enumerate")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"root_domains\": [\n \"<string>\"\n ],\n \"enrichment_inputs\": [\n \"<string>\"\n ],\n \"cloudlist_config_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"steps\": [],\n \"enumeration_ports\": \"<string>\",\n \"alerting_config_ids\": [\n \"<string>\"\n ],\n \"disable_global_alert_config\": true,\n \"exclude_targets\": [\n \"<string>\"\n ],\n \"enumeration_config\": {\n \"follow-redirect\": true,\n \"ports\": \"<string>\"\n },\n \"automatic_vuln_scans\": true,\n \"per_domain_enumeration\": true,\n \"agent_id\": \"<string>\",\n \"agent_tags\": [\n \"<string>\"\n ],\n \"agent_networks\": [\n \"<string>\"\n ],\n \"agent_behavior\": \"distribute\",\n \"agent_auto_discover\": true,\n \"exclusions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.projectdiscovery.io/v1/asset/enumerate")
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 \"root_domains\": [\n \"<string>\"\n ],\n \"enrichment_inputs\": [\n \"<string>\"\n ],\n \"cloudlist_config_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"steps\": [],\n \"enumeration_ports\": \"<string>\",\n \"alerting_config_ids\": [\n \"<string>\"\n ],\n \"disable_global_alert_config\": true,\n \"exclude_targets\": [\n \"<string>\"\n ],\n \"enumeration_config\": {\n \"follow-redirect\": true,\n \"ports\": \"<string>\"\n },\n \"automatic_vuln_scans\": true,\n \"per_domain_enumeration\": true,\n \"agent_id\": \"<string>\",\n \"agent_tags\": [\n \"<string>\"\n ],\n \"agent_networks\": [\n \"<string>\"\n ],\n \"agent_behavior\": \"distribute\",\n \"agent_auto_discover\": true,\n \"exclusions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"truncated-scan-targets": 123,
"is-public": true,
"bulk_ids": [
"<string>"
],
"failed_domains": {}
}{
"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
}{
"message": "<string>",
"kind": "<string>",
"code": "<string>",
"error": "<string>",
"error_id": "<string>",
"param": "<string>",
"status": 123
}Asset Discovery
Create Enumeration
Create a new enumeration
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": [],
"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>"
]
}
'import requests
url = "https://api.projectdiscovery.io/v1/asset/enumerate"
payload = {
"root_domains": ["<string>"],
"enrichment_inputs": ["<string>"],
"cloudlist_config_ids": ["<string>"],
"name": "<string>",
"steps": [],
"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>"]
}
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({
root_domains: ['<string>'],
enrichment_inputs: ['<string>'],
cloudlist_config_ids: ['<string>'],
name: '<string>',
steps: [],
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>']
})
};
fetch('https://api.projectdiscovery.io/v1/asset/enumerate', 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/asset/enumerate",
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([
'root_domains' => [
'<string>'
],
'enrichment_inputs' => [
'<string>'
],
'cloudlist_config_ids' => [
'<string>'
],
'name' => '<string>',
'steps' => [
],
'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>'
]
]),
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/asset/enumerate"
payload := strings.NewReader("{\n \"root_domains\": [\n \"<string>\"\n ],\n \"enrichment_inputs\": [\n \"<string>\"\n ],\n \"cloudlist_config_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"steps\": [],\n \"enumeration_ports\": \"<string>\",\n \"alerting_config_ids\": [\n \"<string>\"\n ],\n \"disable_global_alert_config\": true,\n \"exclude_targets\": [\n \"<string>\"\n ],\n \"enumeration_config\": {\n \"follow-redirect\": true,\n \"ports\": \"<string>\"\n },\n \"automatic_vuln_scans\": true,\n \"per_domain_enumeration\": true,\n \"agent_id\": \"<string>\",\n \"agent_tags\": [\n \"<string>\"\n ],\n \"agent_networks\": [\n \"<string>\"\n ],\n \"agent_behavior\": \"distribute\",\n \"agent_auto_discover\": 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/asset/enumerate")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"root_domains\": [\n \"<string>\"\n ],\n \"enrichment_inputs\": [\n \"<string>\"\n ],\n \"cloudlist_config_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"steps\": [],\n \"enumeration_ports\": \"<string>\",\n \"alerting_config_ids\": [\n \"<string>\"\n ],\n \"disable_global_alert_config\": true,\n \"exclude_targets\": [\n \"<string>\"\n ],\n \"enumeration_config\": {\n \"follow-redirect\": true,\n \"ports\": \"<string>\"\n },\n \"automatic_vuln_scans\": true,\n \"per_domain_enumeration\": true,\n \"agent_id\": \"<string>\",\n \"agent_tags\": [\n \"<string>\"\n ],\n \"agent_networks\": [\n \"<string>\"\n ],\n \"agent_behavior\": \"distribute\",\n \"agent_auto_discover\": true,\n \"exclusions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.projectdiscovery.io/v1/asset/enumerate")
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 \"root_domains\": [\n \"<string>\"\n ],\n \"enrichment_inputs\": [\n \"<string>\"\n ],\n \"cloudlist_config_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"steps\": [],\n \"enumeration_ports\": \"<string>\",\n \"alerting_config_ids\": [\n \"<string>\"\n ],\n \"disable_global_alert_config\": true,\n \"exclude_targets\": [\n \"<string>\"\n ],\n \"enumeration_config\": {\n \"follow-redirect\": true,\n \"ports\": \"<string>\"\n },\n \"automatic_vuln_scans\": true,\n \"per_domain_enumeration\": true,\n \"agent_id\": \"<string>\",\n \"agent_tags\": [\n \"<string>\"\n ],\n \"agent_networks\": [\n \"<string>\"\n ],\n \"agent_behavior\": \"distribute\",\n \"agent_auto_discover\": true,\n \"exclusions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"truncated-scan-targets": 123,
"is-public": true,
"bulk_ids": [
"<string>"
],
"failed_domains": {}
}{
"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
}{
"message": "<string>",
"kind": "<string>",
"code": "<string>",
"error": "<string>",
"error_id": "<string>",
"param": "<string>",
"status": 123
}Authorizations
Headers
Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team
Body
application/json
Available options:
dns_resolve, dns_bruteforce, dns_permute, port_scan, http_probe, http_screenshot, endpoint_crawling, dns_passive, tls_scan, uncover_assets, dns_scraping Show child attributes
Show child attributes
Available options:
distribute, mirror Was this page helpful?
⌘I