Documentation Home

Community

ProjectDiscovery Documentation

Getting Started

Tools

Templates

Cloud

Help

Try Cloud

Get User Profile

X API Key

Welcome to the ProjectDiscovery documentation site

Introduction

Details on navigating our documentation site and the content available here

Using the docs

Learn about ProjectDiscovery and our open source tools

What is ProjectDiscovery?

ProjectDiscovery Introduction

New to ProjectDiscovery and looking to get started?

Start Here!

Start Here

Follow the steps below to setup and try out Nuclei

Example Walkthrough

You successfully completed the Getting Started example, what's next?

What's Next?

Learn about ProjectDiscovery's Open Source Tools

Overview

Open Source Tools

 A fast and customisable vulnerability scanner powered by simple YAML based templates

Nuclei Overview

Learn about how to install and get started with Nuclei

Install

Installing Nuclei

Learn about how to run Nuclei and produce results

Running

Running Nuclei

Common questions and answers about Nuclei

Nuclei FAQ

An HTTP toolkit that probes services, web servers, and other valuable metadata

httpx Overview

Learn about how to install and get started with httpx

Installing httpx

Learn httpx usage including flags, probes, and options

Usage

Httpx Usage

Learn about running httpx with examples including commands and output

Running httpx

A robust discovery tool for passive enumeration on valid subdomains

Subfinder Overview

Learn about how to install and get started with Subfinder

Installing Subfinder

Learn Subfinder usage including input, flags, and filters

Subfinder Usage

Learn about running Subfinder with examples including commands and output

A web crawling framework designed to navigate and parse for hidden details

Katana Overview

Installing Katana

Review Katana usage including flags, configs, and options

Katana Usage

Learn about running Katana with examples including commands and output

Running Katana

YAML based universal language for describing exploitable vulnerabilities

Introduction to Nuclei Templates

Learn the common elements required to create a Nuclei Template

Structure

Nuclei Template Structure

Some common questions and answers about Nuclei templates

Templates FAQ

Basic HTTP

Raw HTTP

Learn about using a headless browser with Nuclei

Headless

Network

Learn about using Nuclei to work with the local file system

File

Learn more about using JavaScript with Nuclei v3

JavaScript Protocol Introduction

Review examples of JavaScript with Nuclei v3

Protocol

JavaScript Protocol

Learn about using external code with Nuclei

Code

Learn about the template flow engine in Nuclei v3

Flow

Learn about multi-protocol support in Nuclei v3

Multi-protocol

Matchers

Extractors

Variables

Review details on helper functions for Nuclei

Helper Functions

Review details on pre-processors for Nuclei

Preprocessors

Review details on template signing for Nuclei

Template Signing

Understanding OOB testing with Nuclei Templates

OOB Testing

Template Workflows

Template Workflows Overview

Review some template workflow examples for Nuclei

Examples

Workflow Examples

Introduction to ProjectDiscovery Cloud Platform

Review your Nuclei results in an integrated dashboard through ProjectDiscovery Cloud Platform

Nuclei Dashboard

Introducing the Nuclei Results Dashboard

Learn about using the Nuclei template editor

Template Editor Introduction

Review details on using AI to help generate Nuclei templates

AI Assistance

Template Sharing

Review keyboard shortcuts for Nuclei templates

Keyboard Shortcuts

Editor Keyboard Shortcuts

Cloud Scanning Introduction

Details on the ProjectDiscovery Cloud Platform API

Cloud API Reference Introduction

Get Asset list

Upload Asset

Get Asset Info

Delete Asset

Update Asset Metadata

Get Asset Content

Update Asset Content

Get Public Template List

Get Public Template Data

Get Template List

Create Template

Update Template

Get Template Data

Delete Template

Generate AI Template

Get Share Status

Share Template

Get Shared Template

Get Scans Status

Create Scan

Get Scan by ID

Delete Scan

Update Scan

Import OSS Scan

Results Filters

Get Scan Schedules

Set Scan Schedule

Delete Scan Schedule

Get Result by scanID

Get Results

Get Vulnerability by ID

Results Stats

Get Retest Results

Create Retest Scan

Get Retest Vulnerability

Create API Key

Get API Key

Delete API Key

Rotate API Key

Add feedback

Review your options for getting help from ProjectDiscovery

API Reference

Get User Profile

Authorizations

Response