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

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

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

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

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

9 operations 9 paths 24 schemas 9 GET

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 Vulnerability 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 9

Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.

Vulnerability 9
GET
/v2/vulnerability/search
Full Text Search
get-v2-vulnerability-search 10 params → 200400401403404500default
GET
/v2/vulnerability/{id}
Get Vulnerability by ID
get-vulnerability-by-id 2 params → 200400404500default
GET
/v2/vulnerability/filters
Get All Filters for Vulnerabilities
get-v2-vulnerability-filters → 200400404500default
GET
/v2/vulnerability/product/search
Search Products
get-v2-product-search 10 params → 200400401403404500default
GET
/v2/vulnerability/product/{id}
Get Product by ID
get-product-by-id 2 params → 200400404500default
GET
/v2/vulnerability/product/{id}/vulns
Get Vulnerabilities for Product
get-product-vulns 11 params → 200400404500default
GET
/v2/vulnerability/product/{id}/timeline
Get Vulnerability Timeline for Product
get-product-timeline 11 params → 200400404500default
GET
/v2/vulnerability/product/filters
Get All Filters for Products
get-v2-product-filters → 200400404500default
GET
/v2/vulnerability/{id}/timeline
Get Vulnerability Timeline
get-vulnerability-timeline 2 params → 200400404500default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Product (27 properties), CVEInfo (24 properties), ProductInfo (12 properties), TemplateSourceMeta (8 properties). Each schema is shown below with its type and property counts.

TemplateContent
object
6 properties
TimelineEvent
object
5 properties 2 required
Classification
object
Classification of template including additional metadata like cve-id, cwe-id etc
7 properties
ProductInfo
object
12 properties
Facets
object
4 properties
VulnExposure
object
3 properties
NucleiTemplate
object
CVEInfo
object
24 properties
H1Stats
object
4 properties
Product
object
27 properties 6 required
TemplateSharingMetadata
object
6 properties
Citation
object
4 properties
VulnerabilityInfo
object
Vulnerability
object
SearchEngineStats
object
3 properties
POC
object
3 properties
AIMeta
object
4 properties
VulnTimelineResponse
object
7 properties
TemplateSourceMeta
object
8 properties
KevInfo
object
4 properties
TemplateFileMeta
object
3 properties
TemplateStatus
object
5 properties
ExposureStats
object
5 properties
Weakness
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-vulnerability-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