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

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

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

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

This API exposes 14 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.

14 operations 7 paths 11 schemas 3 DELETE4 GET2 PATCH5 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 configurations 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 14

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

configurations 14
GET
/v1/scans/config
Get Configs List
get-v1-scans-config 5 params → 200400401403500default
POST
/v1/scans/config
Add Config
post-v1-scans-config 1 param body → 200400401403500default
GET
/v1/scans/config/{config_id}
Get Config
get-v1-scans-config-config_id 3 params → 200400401403500default
PATCH
/v1/scans/config/{config_id}
Update Config
patch-v1-scans-config-config_id 3 params body → 200400401403500default
DELETE
/v1/scans/config/{config_id}
Delete Config
delete-v1-scans-config-config_id 2 params → 200400401403500default
POST
/v1/scans/config/verify
Verify Config
post-v1-scans-config-verify 1 param body → 200400401500default
POST
/v1/scans/config/verify/contents
Get Verify Config Contents
post-v1-scans-config-verify-contents 4 params body → 200400401500default
GET
/v1/scans/config/exclude
Get excluded templates
get-scans-config-exclude 1 param → 200400401500default
POST
/v1/scans/config/exclude
Add excluded templates and targets
post-scans-config-exclude 1 param body → 200400401500default
DELETE
/v1/scans/config/exclude
Delete excluded templates or targets by ids
delete-scans-config-exclude 1 param body → 200400401500default
GET
/v1/scans/config/severity
Get custom severity mappings
get-v1-scans-config-severity 1 param → 200400401404500default
POST
/v1/scans/config/severity
Add custom severity mapping
post-v1-scans-config-severity 1 param body → 200400401404500default
DELETE
/v1/scans/config/severity
Delete custom severity mapping
delete-v1-scans-config-severity 1 param body → 200400401404500default
PATCH
/v1/scans/config/{config_id}/severity
Modify custom severity mapping
patch-v1-scans-config-config_id-severity 2 params body → 200400401404500default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ConfigResponse (9 properties), ExcludedTemplate (7 properties), CustomSeverityMapping (7 properties), JiraVerifyContentItem (5 properties). Each schema is shown below with its type and property counts.

VerifyConfigContentsRequestProvider
string
ExcludeConfigRequestType
string
LinearVerifyContentItem
object
3 properties 3 required
JiraField
object
3 properties 3 required
ConfigTypeEnum
string
JiraVerifyContentItem
object
5 properties 3 required
JiraVerifyContentItemIssueType
object
3 properties 2 required
LinearVerifyContentItemOpenState
object
2 properties 2 required
CustomSeverityMapping
object
7 properties 6 required
ConfigResponse
object
9 properties 6 required
ExcludedTemplate
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuclei-configurations-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 deprecated API
Nuclei domains API
Nuclei elog API
Nuclei enumeration API
Nuclei enumerations API