Nuclei scan API
The scan API from Nuclei — 5 operation(s) for scan.
Nuclei scan API is one of 36 APIs that Nuclei publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include scan. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 5 paths, and defines 9 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Nuclei scan 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 5
Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are AssetFilters (22 properties), StatusBreakdown (7 properties), SeverityBreakdown (6 properties), RemediationEfficiencyData (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nuclei 12
Other APIs Nuclei publishes across the network.