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

The assets API from Nuclei — 9 operation(s) for assets.

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

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

This API exposes 17 operations across 9 paths, and defines 5 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.

17 operations 9 paths 5 schemas 4 DELETE6 GET5 PATCH2 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 assets 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 17

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

assets 17
GET
/v1/assets
Get Asset List
get-v1-assets 4 params → 200401500default
POST
/v1/assets
Upload Asset
post-v1-assets 3 params body → 200401500default
GET
/v1/assets/{asset_Id}
Get Asset Metadata
get-v1-assets-assetId 2 params → 200401500default
DELETE
/v1/assets/{asset_Id}
Delete Asset
delete-v1-assets-asset_Id 2 params → 200401500default
PATCH
/v1/assets/{asset_Id}
Update Asset Metadata
patch-v1-assets-asset_Id 2 params body → 200401500default
GET
/v1/assets/{asset_id}/contents
Get Asset Content
get-v1-assets-id-contents 2 params → 200401500default
PATCH
/v1/assets/{asset_id}/contents
Update Asset Content
patch-v1-assets-asset_id-contents 4 params body → 200400500default
GET
/v1/asset/{asset_id}/changelogs
Get Asset Changelogs for a given assetid
get-v1-asset-assetId-changelogs 8 params → 200400401500default
GET
/v1/asset/changelogs
Get Asset Changelogs for all assets
get-v1-asset-changelogs 7 params → 200400401500default
GET
/v1/asset/{asset_id}
Get enumerated asset details
get-v1-asset-id 2 params → 200400401404500default
DELETE
/v1/asset/{asset_id}
Delete enumerated asset
delete-v1-asset-asset_id 2 params → 200400401500default
PATCH
/v1/asset/{asset_id}
Update asset details
patch-v1-asset-asset_id 2 params body → 200400401500default
DELETE
/v1/asset
Delete asset by filters
delete-v1-asset 1 param body → 200400401404500default
PATCH
/v1/asset/labels
Update Asset Labels
patch-v1-asset-labels 2 params body → 200400401404500default
POST
/v1/asset/{asset_id}/labels
Add labels to an asset
post-v1-asset-id-labels 2 params body → 200400401404500default
PATCH
/v1/asset/{asset_id}/labels
Modify labels of an asset
patch-v1-asset-id-labels 2 params body → 200400401404500default
DELETE
/v1/asset/{asset_id}/labels
Delete labels of an asset
delete-v1-asset-id-labels 2 params → 200400401404500default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AssetFilters (22 properties), AssetChangelogs (21 properties), AssetListItem (4 properties), VulnerabilityChangelogsEvent (3 properties). Each schema is shown below with its type and property counts.

AssetFilters
object
22 properties
TimeRangeQueryParameter
string
AssetListItem
object
4 properties 4 required
AssetChangelogs
object
21 properties 5 required
VulnerabilityChangelogsEvent
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-assets-api-openapi.yml Raw ↑

Other APIs Nuclei publishes across the network.

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