Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nuclei enumerations API

The enumerations API from Nuclei — 20 operation(s) for enumerations.

Nuclei enumerations API is one of 36 APIs that Nuclei publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include enumerations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 20 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 3 base URLs: https://api.projectdiscovery.io, https://api.dev.projectdiscovery.io, http://localhost:8085.

27 operations 20 paths 16 schemas 4 DELETE16 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.projectdiscovery.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nuclei enumerations API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (X-API-Key). By default, every request must be authenticated.

Paths & Operations 27

Across 20 paths, the API surfaces 27 operations — 4 DELETE, 16 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

enumerations 27
GET
/v1/asset/enumerate
Get Enumeration List
get-v1-asset-enumerate 13 params → 200400401403500default
POST
/v1/asset/enumerate
Create Enumeration
post-v1-asset-enumerate 1 param body → 200400401403500default
DELETE
/v1/asset/enumerate
Delete Assets in bulk
delete-v1-asset-enumerates 1 param body → 200400401500default
GET
/v1/asset/enumerate/{enumerate_id}
Get Enumeration
get-v1-asset-enumerate-enumerate_id 2 params → 200400401403499500default
PATCH
/v1/asset/enumerate/{enumerate_id}
Update Enumeration
patch-v1-asset-enumerate-enumerate_id 2 params body → 200400401403500default
DELETE
/v1/asset/enumerate/{enumerate_id}
Delete Enumeration
delete-v1-asset-enumerate-enumerate_id 2 params → 200400401500default
GET
/v1/asset/enumerate/{enumerate_id}/contents
Get Enumeration Contents
get-v1-asset-enumerate-enumerate_id-contents 29 params → 200400401403500default
GET
/v1/asset/enumerate/contents
Get All Enumeration Contents
get-v1-asset-enumerate-contents 26 params → 200400401403500default
POST
/v1/asset/enumerate/{enumerate_id}/stop
Stop Enumeration
post-v1-asset-enumerate-enumerate_id-stop 2 params → 200400401500default
POST
/v1/asset/enumerate/{enumerate_id}/rescan
Rescan Enumeration
post-v1-asset-enumerate-enumerate_id-rescan 2 params → 200400401403500default
GET
/v1/asset/enumerate/{enum_id}/export
Export Enumeration
get-enumerate-id-export 26 params → 200201400401500default
POST
/v1/asset/enumerate/group
Create an asset group
post-v1-asset-enumerate-group 1 param body → 200400401403500default
DELETE
/v1/asset/enumerate/group/{group_id}
Delete an asset group
delete-v1-asset-enumerate-group 2 params → 200400401403500default
PATCH
/v1/asset/enumerate/group/{group_id}
Update an asset group
patch-v1-asset-enumerate-group 3 params body → 200400401403500default
GET
/v1/enumeration/schedule
Get Enumeration Schedules
get-v1-enumeration-schedule 1 param → 200400401500default
POST
/v1/enumeration/schedule
Set Enumeration Schedule
post-v1-enumeration-schedule 1 param body → 200400401500default
DELETE
/v1/enumeration/schedule
Delete Enumeration Schedule
delete-v1-enumeration-schedule 2 params → 200400401500default
GET
/v1/asset/enumerate/{enumerate_id}/stats
Get enumeration stats
get-v1-asset-enumerate-enumerate_id-stats 8 params → 200400401500default
GET
/v1/asset/domain/{domain_name}/stats
Get domain stats
get-v1-asset-domain-domain_name-stats 5 params → 200400401500default
GET
/v1/asset/enumerate/stats
Get all enumeration stats
get-v1-asset-enumerate-stats 6 params → 200400401500default
GET
/v1/asset/enumerate/{enumerate_id}/config
Get enumeration config
get-v1-asset-enumerate-enumerate_id-config 2 params → 200400401500default
GET
/v1/asset/enumerate/filters
Group assets by filters
get-v1-asset-enumerate-filters 27 params → 200400401500default
GET
/v1/asset/enumerate/{enumerate_id}/filters
Group assets by filters for an enumeration
get-v1-asset-enumerate-id-filters 29 params → 200400401500default
GET
/v1/asset/domain/{domain_name}/filters
Group assets by filters for an domain
get-v1-asset-domain-domain-name-filters 23 params → 200400401500default
GET
/v1/asset/enumerate/export
Export Enumeration of user
get-enumerate-export 25 params → 200201400401500default
GET
/v1/asset/domain/{domain_name}
Get Enumeration Domain Contents
get-v1-asset-domain-domain_name-contents 25 params → 200400401403500default
GET
/v1/asset/domain/{domain_name}/export
Export Enumeration of user by domain
get-v1-asset-domain-domain_name-export 24 params → 200201400401500default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are EnumerationContent (47 properties), EnumerateData (32 properties), AssetFilters (22 properties), EnumerateFiltersItem (12 properties). Each schema is shown below with its type and property counts.

EnumerationLaunchConfig
object
2 properties
EnumExportFormats
string
EnumerateFilterTypes
string
AssetFilters
object
22 properties
AssetStats
object
10 properties 8 required
EnumerateData
object
32 properties 4 required
EnumerationContentTechnologyDetails
object
4 properties
TimeRangeQueryParameter
string
SchedulerFrequency
string
Allowed frequencies for the scheduler
EnumerationConfig
object
10 properties
EnumerationContent
object
47 properties 5 required
EnumerationSchedule
object
7 properties 4 required
EnumerationSourceValue
object
2 properties 2 required
EnumerationStats
object
6 properties 5 required
EnumerateFiltersItem
object
12 properties 2 required
EnumerationCounts
object
Example response
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-enumerations-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

Nuclei agents API
Nuclei Asset API
Nuclei assets API
Nuclei automations API
Nuclei billing API
Nuclei chaos API
Nuclei configurations API
Nuclei deprecated API
Nuclei domains API
Nuclei elog API
Nuclei enumeration API