Scan Template

Scan target host using a specified nuclei template.

POST /v1/template/user/scan

Scan Template

cURL

curl --request POST \
  --url https://templates-api.nuclei.sh/v1/template/user/scan \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "template_base64": "<string>"
}
'

import requests

url = "https://templates-api.nuclei.sh/v1/template/user/scan"

payload = {
    "target": "<string>",
    "template_base64": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({target: '<string>', template_base64: '<string>'})
};

fetch('https://templates-api.nuclei.sh/v1/template/user/scan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://templates-api.nuclei.sh/v1/template/user/scan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target' => '<string>',
    'template_base64' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://templates-api.nuclei.sh/v1/template/user/scan"

	payload := strings.NewReader("{\n  \"target\": \"<string>\",\n  \"template_base64\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://templates-api.nuclei.sh/v1/template/user/scan")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": \"<string>\",\n  \"template_base64\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://templates-api.nuclei.sh/v1/template/user/scan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target\": \"<string>\",\n  \"template_base64\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Parameters (required)

target · string · required

Target host to scan using nuclei template.

Constraints: Valid hostname or IP address or URL.

template_base64 · string · required

Base64 encoded nuclei template.

Constraints: Valid Base64 encoded template.