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 Asset API

The Asset API from Nuclei — 12 operation(s) for asset.

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

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

This API exposes 15 operations across 12 paths, and defines 14 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.

15 operations 12 paths 14 schemas 1 DELETE11 GET2 PATCH1 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 Asset 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 15

Across 12 paths, the API surfaces 15 operations — 1 DELETE, 11 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Asset 15
PATCH
/v1/asset/enumerate/{enumerate_id}/config
Update enumeration config
patch-v1-asset-enumerate-enumerate_id-config 3 params body → 200400401500default
GET
/v1/asset/enumerate/{enumerate_id}/history
Get asset enumeration history data
get-v1-asset-enumerate-enumerate_id-history 7 params → 200400401403500default
GET
/v1/asset/enumerate/misconfiguration
List Misconfiguration Findings
get-v1-asset-enumerate-misconfiguration 5 params → 200400401403500default
GET
/v1/asset/policy
List asset policies
get-v1-asset-policy 2 params → 200400401404500default
POST
/v1/asset/policy
Create asset policy
post-v1-asset-policy body → 200400401404500default
GET
/v1/asset/policy/{policy_id}
Get asset policy
get-v1-asset-policy-policy_id 1 param → 200400401404500default
PATCH
/v1/asset/policy/{policy_id}
Update asset policy
patch-v1-asset-policy-policy_id 2 params body → 200400401404500default
DELETE
/v1/asset/policy/{policy_id}
Delete asset policy
delete-v1-asset-policy-policy_id 1 param → 200400401404500default
GET
/v1/asset/policy/suggestion
Get asset policy suggestions
get-v1-asset-policy-suggestion 3 params → 200400401404500default
GET
/v1/asset/policy/{policy_id}/events
Get asset policy events
get-v1-asset-policy-policy_id-events 3 params → 200400401404500default
GET
/v1/asset/enumerate/domains
Get list of unique domains discovered in current month
get-v1-asset-enumerate-domains 3 params → 200400401404500default
GET
/v1/asset/enumerate/domains/export
Export list of unique domains discovered in current month
get-v1-asset-enumerate-domains-export 4 params → 200400401404500default
GET
/v1/asset/enumerate/{enumerate_id}/domains
Get list of unique domains discovered in an enumeration
get-v1-asset-enumerate-enum-id-domains 4 params → 200400401404500default
GET
/v1/asset/enumerate/{enumerate_id}/domains/export
Export the list of unique input domains of an enumeration.
get-v1-asset-enumerate-enum-id-domains-export 3 params → 200400401404500default
GET
/v1/asset/exposures/metrics
Get exposure metrics
get-v1-asset-exposures-metrics 2 params → 200400401404500default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are AssetFilters (22 properties), ActivityEvent (15 properties), AssetPolicy (12 properties), EnumerationHistoryDataResponse (10 properties). Each schema is shown below with its type and property counts.

AssetPolicyListResponse
object
3 properties 2 required
AssetPolicy
object
12 properties 6 required
EnumerationLaunchConfig
object
2 properties
AssetFilters
object
22 properties
AssetPolicySuggestionsResponse
object
3 properties 2 required
ExposuresTimeSeries
object
4 properties
TimeRangeQueryParameter
string
EnumerationConfig
object
10 properties
ActivityEvent
object
15 properties 5 required
EnumerationDomainListItem
object
2 properties 2 required
AssetPolicySuggestion
object
9 properties 7 required
EnumerationHistoryDataResponse
object
10 properties 9 required
MisconfigurationResponse
object
9 properties
AssetPolicyType
string
Type of action to perform when policy matches assets

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-asset-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

Nuclei agents 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
Nuclei enumerations API