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

The templates API from Nuclei — 12 operation(s) for templates.

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

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

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

16 operations 12 paths 7 schemas 1 DELETE11 GET1 PATCH3 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 templates 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 16

Across 12 paths, the API surfaces 16 operations — 1 DELETE, 11 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

templates 16
GET
/v1/template/public
Get Public Template List
get-v1-template-public 4 params → 200400500default
GET
/v1/template/early
Get Early Template List
get-v1-early-templates 4 params → 200400403500default
GET
/v1/template/early/{id}
Get Early Template
get-v1-early-templates-id 2 params → 200400403404500default
GET
/v1/template/public/{template_id}
Get Public Template
get-v1-public-template-data 3 params → 200400500default
GET
/v1/template
Get Template List
get-v1-templates 4 params → 200401500default
POST
/v1/template
Create Template
post-v1-template 3 params body → 200400401500default
PATCH
/v1/template
Update Template
patch-v1-template 1 param body → 200400401500default
GET
/v1/template/{template_id}
Get Template
get-v1-template-t_id 2 params → 200400401404500default
DELETE
/v1/template/{template_id}
Delete Template
delete-v1-template-template_id 2 params → 200400401500default
POST
/v1/template/ai
Generate AI Template
post-v1-template-ai 1 param body → 200400401403500default
GET
/v1/template/share
Get Shared Template List
get-v1-template-share 6 params → 200400401404500default
POST
/v1/template/share
Share Template
post-v1-template-share 1 param body → 200400401404500default
GET
/v1/template/share/{template_id}
Get Shared Template
get-v1-template-share-template_id 2 params body → 200400401404500default
GET
/v1/template/github
Get Github Template List
get-v1-github-templates 4 params → 200401500default
GET
/v1/template/github/{id}
Get Github Template
get-v1-github-templates-id 2 params body → 200400401404500default
GET
/v1/template/stats
Get Public Template Stats
get-v1-template-stats 7 params → 200400401500default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TemplateData (31 properties), TemplateStats (10 properties), Classification (7 properties), SharedTemplateMetaData (5 properties). Each schema is shown below with its type and property counts.

SharedTemplateData
TemplateData
object
Template Document or object
31 properties
Classification
object
Classification of template including additional metadata like cve-id, cwe-id etc
7 properties
TemplateStats
object
10 properties 4 required
AIMeta
object
4 properties
SharedTemplateMetaData
object
5 properties
StatBuckets
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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