Skip to main content
GET
/
v1
/
asset
/
enumerate
Get Enumeration List
curl --request GET \
  --url https://api.projectdiscovery.io/v1/asset/enumerate \
  --header 'X-API-Key: <api-key>'
{
  "current_page": 123,
  "result_count": 123,
  "total_results": 123,
  "total_pages": 123,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "failure_reason": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "enumeration_time": "<string>",
      "enumeration_type": "<string>",
      "enumeration_stats": {
        "hosts": 123,
        "http": 123,
        "endpoints": 123,
        "ports": 123,
        "total_assets": 123,
        "total_asset_groups": 123
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "root_domains": [
        "<string>"
      ],
      "exclusions": [
        "<string>"
      ],
      "enrichment_hosts_count": 123,
      "is_rescan": true,
      "rescan_count": 123,
      "cloudlist_config_ids": [
        "<string>"
      ],
      "cloudlist_provider_name": "<string>",
      "enumeration_time_elapsed": "<string>",
      "total_assets": 123,
      "new_assets": 123,
      "domain_names": [
        "<string>"
      ],
      "schedule": {
        "enumeration_id": "<string>",
        "scan_frequency": "<string>",
        "schedule_last_run": "<string>",
        "schedule_next_run": "<string>",
        "start_time": "<string>",
        "hourly_frequency": 123,
        "custom_weekdays": [
          3
        ]
      },
      "is_public": true,
      "asset_group_filters": {
        "is_tech": true,
        "is_favicon": true,
        "is_new": true,
        "labels": "<string>",
        "host": "<string>",
        "port": "<string>",
        "status_code": "<string>",
        "content_length": "<string>",
        "title": "<string>",
        "domain": [
          "<string>"
        ],
        "cname": "<string>",
        "technologies": "<string>",
        "ip": "<string>",
        "is_screenshot": true,
        "time": "last_day",
        "start_date": "2023-12-25",
        "end_date": "2023-12-25",
        "custom_filter": "<string>",
        "search": "<string>",
        "enumeration_id": "<string>",
        "only_dns": true,
        "only_ip": true
      },
      "body": "<string>",
      "agent_id": "<string>",
      "agent_tags": [
        "<string>"
      ],
      "agent_networks": [
        "<string>"
      ],
      "agent_behavior": "distribute",
      "agent_auto_discover": true,
      "automatic_vuln_scans": true,
      "is_internal": true
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Team-Id
string

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

Query Parameters

​
offset
integer

The number of items to skip before starting to collect the result set

​
limit
integer

The numbers of items to return

​
search
string

search keyword in enumeration list

​
enum_type
string

types of enumeration list (comma seperated)

​
sort_asc
string

comma separated ascending sorting e.g sort_asc=created_at,name

​
sort_desc
string

comma separated descending sorting e.g sort_desc=created_at,name

​
status
string

comma separated filter enumeration result by status

​
time
enum<string>
default:all_time

time range to get enumerations from

Available options:
last_day,
last_week,
last_month,
last_3_months,
last_6_months,
last_12_months,
all_time
​
start_date
string<date>

time filter start date

​
end_date
string<date>

time filter end date

​
custom_filter
string

custom query to filter. double encode the query string.

​
is_internal
boolean

filter by internal enumerations

Response

Example response

​
current_page
integer
required
​
result_count
integer
required
​
total_results
integer
required
​
total_pages
integer
required
​
data
EnumerateData · object[]
required