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

The Scans API from Nuclei — 24 operation(s) for scans.

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

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

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

34 operations 24 paths 23 schemas 5 DELETE16 GET5 PATCH8 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 Scans 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 34

Across 24 paths, the API surfaces 34 operations — 5 DELETE, 16 GET, 5 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Scans 34
DELETE
/v1/scans/vulns/{vuln_id}/ticket
Delete vulns tracker association
delete-vulns-id-ticket 3 params → 200400401424500default
POST
/v1/scans/vulns/{vuln_id}/ticket
Create vulns export to tracker
post-vulns-id-ticket 3 params body → 200400401424500default
GET
/v1/scans/{scan_id}/error_stats
Get error statistics of given scan id
get-scans-id-error-stats 1 param → 200400401403500default
GET
/v1/scans
Get Scan List
get-v1-scans 8 params → 200400401499500default
POST
/v1/scans
Create Scan
post-v1-scans 1 param body → 200400401500default
DELETE
/v1/scans
Delete Scan in bulk
delete-v1-scans 1 param body → 200400401500default
GET
/v1/scans/{scan_id}
Get Scan
get-v1-scans-scan_id 2 params → 200400401404499500default
DELETE
/v1/scans/{scan_id}
Delete Scan
delete-v1-scans-scan_id 2 params → 200400401500default
PATCH
/v1/scans/{scan_id}
Update Scan
patch-v1-scans-scan_id 2 params body → 200400401500default
POST
/v1/scans/import
Import OSS Scan
post-v1-scans-import 2 params body → 200400401500default
POST
/v1/scans/{scan_id}/stop
Stop Scan
post-v1-scans-scan_id-stop 2 params → 200400401500default
POST
/v1/scans/{scan_id}/rescan
Rescan scan
post-v1-scans-scan_id-rescan 2 params → 200400401500default
GET
/v1/scans/stats
Get All Scan Stats
get-v1-scans-stats 1 param → 200401403499500default
POST
/v1/scans/{vuln_id}/retest
Retest vulnerability
post-v1-scans-vuln_id-retest 2 params body → 200400401500default
GET
/v1/scans/schedule
Get Scan Schedules
get-v1-scans-schedule 1 param → 200400401500default
POST
/v1/scans/schedule
Set Scan Schedule
post-v1-scans-schedule 1 param body → 200400401500default
DELETE
/v1/scans/schedule
Delete Scan Schedule
delete-v1-scans-schedule 2 params → 200400401500default
GET
/v1/scans/scan_ips
Get Scan IPs
get-v1-scans-scan_ips 1 param → 200400401403500default
PATCH
/v1/scans/{scan_id}/import
Update Imported Scan
patch-v1-scans-scan_id-import 2 params body → 200401403500default
GET
/v1/scans/{scan_id}/export
Export Scan
get-v1-scans-scan_id-export 4 params → 200201401403500default
POST
/v1/scans/{scan_id}/export
Export Filtered Scan
post-v1-scans-scan_id-export 4 params body → 200201401403500default
GET
/v1/scans/vuln/{vuln_id}/export
Export Scan Vulnerability
get-v1-scans-vuln-vuln_id-export 3 params → 200401403500default
PATCH
/v1/scans/vulns
Update Vulnerability Status
patch-v1-scans-vulns 1 param body → 200400401500default
DELETE
/v1/scans/vulns
Delete Scan Vulnerability
delete-v1-scans-vulns 1 param body → 200400401500default
PATCH
/v1/scans/vulns/labels
Update Vulnerability Labels
patch-v1-scans-vulns-labels 1 param body → 200400401500default
GET
/v1/scans/{scan_id}/config
Get Scan Config
get-scans-id-config 2 params → 200400401500default
PATCH
/v1/scans/{scan_id}/config
Update Scan Config
patch-scans-id-config 3 params body → 200400401500default
GET
/v1/scans/history
Get All Scans History
get-v1-scans-history 6 params → 200400401500default
GET
/v1/scans/{scanId}/history
Get Scan History
get-v1-scans-scanId-history 7 params → 200400401500default
GET
/v1/scans/asset
Get list of unique assets scanned in current month.
get-v1-scans-assets 7 params → 200400401404500default
GET
/v1/scans/asset/export
Export list of unique assets scanned in current month
get-v1-scans-assets-export 6 params → 200400401404500default
GET
/v1/scans/{scan_id}/asset
Get list of unique assets for a scan.
get-v1-scans-scan-id-assets 4 params → 200400401404500default
GET
/v1/scans/{scan_id}/asset/export
Export list of unique assets for a scan
get-v1-scans-scan-id-assets-export 3 params → 200400401404500default
GET
/v1/scans/token
Get Scans Token
get-v1-scans-token 1 param → 200400401404500default

Schemas 23

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

EnumerationIDTypesDetail
object
6 properties 4 required
VulnIssueTrackerItem
object
2 properties
ScanConfig
object
17 properties
AssetFilters
object
22 properties
StatisticsResponse
object
3 properties
VulnerabilityEvent
object
20 properties
ScanConfigItem
object
4 properties 3 required
ScanAssetListItem
object
3 properties 2 required
ScanAssetListItemOptional
object
3 properties 2 required
EnumerationIds
object
1 property 1 required
EnumerationContentTechnologyDetails
object
4 properties
TimeRangeQueryParameter
string
SchedulerFrequency
string
Allowed frequencies for the scheduler
EnumerationContent
object
47 properties 5 required
ScansHistoryItems
object
12 properties
ScanSchedule
object
7 properties 4 required
EnumerationIDTypes
object
1 property 1 required
ScanStatusItem
object
31 properties 15 required
EnumerationSourceValue
object
2 properties 2 required
VulnerabilityResultsOld
object
20 properties 7 required
VulnStatusEnum
ScanConfigUpdateItem
object
15 properties
PrivateTemplates
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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