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

The results API from Nuclei — 7 operation(s) for results.

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

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

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

7 operations 7 paths 11 schemas 7 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 results 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 7

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

results 7
GET
/v1/scans/vuln/{vuln_id}
Get Scan Vulnerability
get-v1-scans-vuln-:vulnId 2 params → 200400401500default
GET
/v1/scans/result/{scanId}
Get Scan Results
get-v1-scans-result-:scanId 15 params → 200400401499500default
GET
/v1/scans/vuln/{vuln_id}/changelogs
Get Vulnerability Changelogs
get-v1-scans-vuln-vuln_id-changelogs 8 params → 200400401499500default
GET
/v1/scans/vuln/changelogs
Get all Vulnerability Changelogs
get-v1-scans-vuln-changelogs 7 params → 200400401499500default
GET
/v1/scans/results
Get All Results
get-v1-results 20 params → 200400401499500default
GET
/v1/scans/results/filters
Get Scans Result Filters
get-v1-scans-results-filters 25 params → 200401499500default
GET
/v1/scans/results/stats
Get Results Stats
get-v1-scans-results-stats 22 params → 200400401499500default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EnumerationContent (47 properties), VulnerabilityResults (23 properties), VulnerabilityEvent (20 properties), VulnerabilityResultsOld (20 properties). Each schema is shown below with its type and property counts.

EnumerationContentTechnologyDetails
object
4 properties
VulnerabilityEvent
object
20 properties
ScanStats
object
12 properties 8 required
EnumerationSourceValue
object
2 properties 2 required
EnumerationContent
object
47 properties 5 required
VulnerabilityResultsOld
object
20 properties 7 required
FiltersItem
object
4 properties 2 required
VulnerabilityChangelogsEvent
object
3 properties
VulnerabilityResults
object
23 properties 9 required
VulnerabilityChangelogs
object
16 properties 9 required
VulnIssueTrackerItem
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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