Get Enumeration - ProjectDiscovery Documentation

Get Enumeration

curl --request GET \
  --url https://api.projectdiscovery.io/v1/asset/enumerate/{enumerate_id} \
  --header 'X-API-Key: <api-key>'

{
  "message": "<string>",
  "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
  }
}

GET

asset

enumerate

{enumerate_id}

Get Enumeration

curl --request GET \
  --url https://api.projectdiscovery.io/v1/asset/enumerate/{enumerate_id} \
  --header 'X-API-Key: <api-key>'

{
  "message": "<string>",
  "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

Path Parameters

enumerate_id

string

required

Response

Example response

message

string

required

data

EnumerateData · object

required

Show child attributes

data.id

string

required

data.name

string

required

data.status

string

required

data.created_at

string<date-time>

required

data.failure_reason

string

data.completed_at

string<date-time>

data.enumeration_time

string<duration>

data.enumeration_type

string

data.enumeration_stats

EnumerationStats · object

Show child attributes

data.enumeration_stats.hosts

integer<int64>

required

data.enumeration_stats.http

integer<int64>

required

data.enumeration_stats.endpoints

integer<int64>

required

data.enumeration_stats.ports

integer<int64>

required

data.enumeration_stats.total_assets

integer<int64>

required

data.enumeration_stats.total_asset_groups

integer<int64>

data.updated_at

string<date-time>

data.root_domains

string[]

data.exclusions

string[]

Combined inclusion (prefixed with +) and exclusion patterns for discovery scope

data.enrichment_hosts_count

integer

data.is_rescan

boolean

data.rescan_count

integer

data.cloudlist_config_ids

string[]

data.cloudlist_provider_name

string

data.enumeration_time_elapsed

string

data.total_assets

integer<int64>

data.new_assets

integer<int64>

data.domain_names

string[]

data.schedule

EnumerationSchedule · object

Show child attributes

data.schedule.enumeration_id

string

required

data.schedule.scan_frequency

string

required

data.schedule.schedule_last_run

string

required

data.schedule.schedule_next_run

string

required

data.schedule.start_time

string<time>

data.schedule.hourly_frequency

integer

data.schedule.custom_weekdays

integer[]

Array of integer denoting the weekdays on which the scan is supposed to run. 0-6 denoting Sunday-Saturday.

Required range: 0 <= x <= 6

data.is_public

boolean

data.asset_group_filters

AssetFilters · object

Show child attributes

data.asset_group_filters.is_tech

boolean

Return records that have technologies

data.asset_group_filters.is_favicon

boolean

Return the records that have favicon

data.asset_group_filters.is_new

boolean

Filter by new content

data.asset_group_filters.labels

string

Filter by comma separated labels, e.g-> labels=p1,p2

data.asset_group_filters.host

string

Filter by comma separated hosts, e.g-> host=p1,p2

data.asset_group_filters.port

string

Filter by comma separated ports, e.g-> port=p1,p2

data.asset_group_filters.status_code

string

Filter by comma separated status codes, e.g-> status_code=p1,p2

data.asset_group_filters.content_length

string

Filter by comma separated content lengths, e.g-> content_length=p1,p2

data.asset_group_filters.title

string

Filter by comma separated titles, e.g-> title=p1,p2

data.asset_group_filters.domain

string[]

Filter by comma separated domain names, e.g-> domain=domain1.com,domain2.com

data.asset_group_filters.cname

string

Filter by comma separated cnames, e.g-> cname=p1,p2

data.asset_group_filters.technologies

string

Filter by comma separated technologies, e.g-> technologies=p1,p2

data.asset_group_filters.ip

string

Filter by comma separated ips, e.g-> ip=p1,p2

data.asset_group_filters.is_screenshot

boolean

Return the records with screenshots

data.asset_group_filters.time

enum<string>

Filter by time range

Available options:

last_day,

last_week,

last_month,

last_3_months,

last_6_months,

last_12_months,

all_time

data.asset_group_filters.start_date

string<date>

Filter by start date

data.asset_group_filters.end_date

string<date>

Filter by end date

data.asset_group_filters.custom_filter

string

Filter by custom filter. Double encode the query string.

data.asset_group_filters.search

string

Search on the content name

data.asset_group_filters.enumeration_id

string

Filter by enumeration id

data.asset_group_filters.only_dns

boolean

Query only dns FQDN records

data.asset_group_filters.only_ip

boolean

Query only dns IP records

data.body

string

data.agent_id

string

data.agent_tags

string[]

data.agent_networks

string[]

data.agent_behavior

enum<string>

default:distribute

Available options:

distribute,

mirror

data.agent_auto_discover

boolean

data.automatic_vuln_scans

boolean

data.is_internal

boolean

Delete Assets in bulk Delete Enumeration

⌘I

API Reference

Authorizations

Headers

Path Parameters

Response