Connect Your Nuclei Scan to PDCP
Review your Nuclei Scan Results in ProjectDiscovery Cloud Platform
Overview
In this section we’ll walk through the steps you need to run a scan in Nuclei and connect your scan to ProjectDiscovery Cloud Platform (PDCP).
Set up your API Key
To connect your existing Nuclei results to PDCP you will need to create a free API Key
- Visit https://cloud.projectdiscovery.io
- Open the setting menu from the top right and select “API Key” to create your API Key
- Use the
nuclei -auth
command, and enter your API key when prompted.
Configure Team (Optional)
If you want to upload the scan results to a team workspace instead of your personal workspace, you can configure the Team ID. You can use either the CLI option or the environment variable, depending on your preference.
-
Obtain Team ID:
- To obtain your Team ID, navigate to https://cloud.projectdiscovery.io/settings/team and copy the Team ID from the top right section.
-
CLI Option:
- Use the
-tid
or-team-id
option to specify the team ID. - Example:
nuclei -tid XXXXXX -cloud-upload
- Use the
-
ENV Variable:
- Set the
PDCP_TEAM_ID
environment variable to your team ID. - Example:
export PDCP_TEAM_ID=XXXXX
- Set the
Either of these options is sufficient to configure the Team ID.
Run a Scan
To run a scan, from a terminal window with your Nuclei installation, use the nuclei -target
or nuclei -u
option to designate a target/host.
For example, a command might look like:
- This example uses a sample site from ProjectDiscovery (http://honey.scanme.sh)
- The
-cloud-upload
flag is required to share results with PDCP - You can run this command against any URL you want (with appropriate permissions)
- To reduce or narrow the scan results you can select a specific template folder for your scan
- For example
nuclei -u http://buffer.com -t dns/ -cloud-upload
And the output of your command (scan) would be:
Viewing Your Scan
After the scan is complete a URL will display on the command line interface. Visit this URL to check your results in PDCP.
Your scan results will also be available in the Scan tab of PDCP with a generic system generated name. You can rename the scan to identify it later.
After more than one scan “results” tab shows the scan results for all scans in your PDCP environment.
Nuclei scans connected and uploaded to PDCP are scheduled for automatic cleanup after 30 days. This duration is subject to change as we gauge user feedback and requirements.
Features
Scans
Scans offer the ability to:
- View a list of all scans in your PDCP install.
- View details of an individual scan.
- Sort for severity or status, export scan details, change status, search results.
Templates
Templates include our Template Editor to write your own custom templates.
- Experiment with using our AI Assitance to create custom templates.
- Share your custom templates
Learn more about our Templates.
Was this page helpful?