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

The Template API from Nuclei — 4 operation(s) for template.

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

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

This API exposes 6 operations across 4 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.

6 operations 4 paths 11 schemas 1 DELETE2 GET2 PATCH1 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 Template 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 6

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

Template 6
POST
/v2/template/user/upload
Upload Templates
post-v2-template-user-upload body → 200400401404500default
PATCH
/v2/template/user/upload
Bulk Update User Template
patch-v2-template-user-upload body → 200400401404500default
PATCH
/v1/template/share/{template_id}
Update Shared Template
patch-v1-template-share-template_id 1 param body → 200400401500default
DELETE
/v1/template/share/{template_id}
Unshare/Delete template
delete-v1-template-share-template_id 1 param → 200400401500default
GET
/v2/template
Your GET endpoint
get-v2-template 24 params → 200400401404500default
GET
/v1/template/leaderboard/{name}
Get Leaderboard ID Details
get-v1-template-leaderboard-id 4 params → 200400401404500default

Schemas 11

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

Facets
object
4 properties
AIMeta
object
4 properties
TemplateValidationError
object
6 properties 2 required
TemplateData
object
Template Document or object
31 properties
SharedTemplateMetaData
object
5 properties
Classification
object
Classification of template including additional metadata like cve-id, cwe-id etc
7 properties
FailedTemplateFileMetadataUpdate
object
4 properties 4 required
UploadTemplate
object
4 properties
TemplateWorkflowRejection
object
3 properties 2 required
TemplateFileMetadata
object
Template File Metadata
4 properties 4 required
PatchTemplateFileMetadata
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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