# ProjectDiscovery llms.txt

## Overview
ProjectDiscovery is an open-source platform providing a suite of security tools and a cloud API for asset discovery, vulnerability scanning, and threat management. This file details the major tools, all core API endpoints 
(with live links), and comprehensive documentation references to help AI bots and developers quickly leverage ProjectDiscovery’s technologies.

## Major Tools
Below are the major tools with a brief description and their GitHub repository links:

- **AlterX**  
  *Fast and customizable subdomain wordlist generator using a DSL.*  
  GitHub: [projectdiscovery/alterx](https://github.com/projectdiscovery/alterx)

- **Chaos**  
  *Internet-wide asset data source for broad asset discovery.*  
  GitHub: [projectdiscovery/chaos-client](https://github.com/projectdiscovery/chaos-client)

- **Cloudlist**  
  *Enumerate assets across multiple cloud providers to gain full cloud visibility.*  
  GitHub: [projectdiscovery/cloudlist](https://github.com/projectdiscovery/cloudlist)

- **cvemap**  
  *CLI tool to navigate the CVE database and expose vulnerability details.*  
  GitHub: [projectdiscovery/cvemap](https://github.com/projectdiscovery/cvemap)

- **dnsx**  
  *Versatile DNS toolkit for mass DNS resolutions, wildcard testing, and more.*  
  GitHub: [projectdiscovery/dnsx](https://github.com/projectdiscovery/dnsx)

- **httpx**  
  *HTTP toolkit for probing web services, fetching server info, status codes, and metadata.*  
  GitHub: [projectdiscovery/httpx](https://github.com/projectdiscovery/httpx)

- **Interactsh**  
  *Out-of-band interaction server/library for catching OOB callbacks (useful in testing blind vulnerabilities).*  
  GitHub: [projectdiscovery/interactsh](https://github.com/projectdiscovery/interactsh)

- **Katana**  
  *Next-generation web crawling framework to navigate and parse web content for hidden assets.*  
  GitHub: [projectdiscovery/katana](https://github.com/projectdiscovery/katana)

- **Naabu**  
  *Lightning-fast port scanner to quickly identify open ports on target hosts.*  
  GitHub: [projectdiscovery/naabu](https://github.com/projectdiscovery/naabu)

- **Notify**  
  *Streams outputs from various tools to multiple notification platforms for real-time updates.*  
  GitHub: [projectdiscovery/notify](https://github.com/projectdiscovery/notify)

- **Nuclei**  
  *Customizable vulnerability scanner powered by a YAML-based template engine for detecting a variety of issues.*  
  GitHub: [projectdiscovery/nuclei](https://github.com/projectdiscovery/nuclei)

- **PDTM**  
  *Manages all ProjectDiscovery projects; simplifies tool updates and installations.*  
  GitHub: [projectdiscovery/pdtm](https://github.com/projectdiscovery/pdtm)

- **Subfinder**  
  *Robust passive subdomain enumeration tool to map a target’s online assets.*  
  GitHub: [projectdiscovery/subfinder](https://github.com/projectdiscovery/subfinder)

- **Uncover**  
  *Searches and highlights exposed hosts across various public sources for comprehensive discovery.*  
  GitHub: [projectdiscovery/uncover](https://github.com/projectdiscovery/uncover)

## Core API Endpoints
ProjectDiscovery’s Cloud API (base URL: `https://api.projectdiscovery.io/v1/`) follows RESTful conventions. Authentication is done via an `X-API-Key` header. Below is a categorized list of endpoints with direct links to their 
documentation (for full details, parameters, and examples, see the [API Reference](https://docs.projectdiscovery.io/api-reference)).

### Assets Endpoints
- **Get Enumeration List**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#list-enumerations)

- **Create Enumeration**  
  `POST https://api.projectdiscovery.io/v1/assets/enumerations`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#create-enumeration)

- **Get Enumeration**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-enumeration)

- **Delete Enumeration**  
  `DELETE https://api.projectdiscovery.io/v1/assets/enumerations/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#delete-enumeration)

- **Delete Bulk Enumeration**  
  `DELETE https://api.projectdiscovery.io/v1/assets/enumerations/bulk`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#bulk-delete-enumerations)

- **Update Enumeration**  
  `PUT https://api.projectdiscovery.io/v1/assets/enumerations/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#update-enumeration)

- **Get Enumeration Contents**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/{id}/contents`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-enumeration-contents)

- **Get All Enumeration Contents**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/contents`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-all-enumeration-contents)

- **Stop Enumeration**  
  `POST https://api.projectdiscovery.io/v1/assets/enumerations/{id}/stop`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#stop-enumeration)

- **Rescan Enumeration**  
  `POST https://api.projectdiscovery.io/v1/assets/enumerations/{id}/rescan`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#rescan-enumeration)

- **Export Enumeration**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/{id}/export`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#export-enumeration)

- **Update Enumeration Config**  
  `PUT https://api.projectdiscovery.io/v1/assets/enumerations/{id}/config`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#update-enumeration-config)

- **Get Enumeration Schedules**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/schedules`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#list-enumeration-schedules)

- **Set Enumeration Schedule**  
  `POST https://api.projectdiscovery.io/v1/assets/enumerations/schedules`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#set-enumeration-schedule)

- **Delete Enumeration Schedule**  
  `DELETE https://api.projectdiscovery.io/v1/assets/enumerations/schedules/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#delete-enumeration-schedule)

- **Get Enumeration Stats**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/{id}/stats`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-enumeration-stats)

- **Get All Enumeration Stats**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/stats`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-all-enumeration-stats)

- **Get Enumeration Config**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/{id}/config`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-enumeration-config)

- **Group Assets by Filters**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/group`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#group-assets)

- **Group Assets by Filters (per Enumeration)**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/{id}/group`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#group-assets-per-enumeration)

- **Export Enumeration of User**  
  `GET https://api.projectdiscovery.io/v1/assets/enumerations/user/export`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#export-user-enumerations)

- **Upload Asset**  
  `POST https://api.projectdiscovery.io/v1/assets`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#upload-asset)

- **Update Asset Content**  
  `PUT https://api.projectdiscovery.io/v1/assets/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#update-asset)

- **Get Asset Metadata**  
  `GET https://api.projectdiscovery.io/v1/assets/{id}/metadata`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-asset-metadata)

- **Get Asset Content**  
  `GET https://api.projectdiscovery.io/v1/assets/{id}/content`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#get-asset-content)

- **Delete Asset**  
  `DELETE https://api.projectdiscovery.io/v1/assets/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/assets#delete-asset)

### Scans Endpoints
- **Create Scan**  
  `POST https://api.projectdiscovery.io/v1/scans`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#create-scan)

- **Create Vulns Export to Tracker**  
  `POST https://api.projectdiscovery.io/v1/scans/{id}/vulns/export`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#create-vulns-export)

- **Delete Scan**  
  `DELETE https://api.projectdiscovery.io/v1/scans/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#delete-scan)

- **Delete Bulk Scans**  
  `DELETE https://api.projectdiscovery.io/v1/scans/bulk`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#bulk-delete-scans)

- **Delete Scan Schedule**  
  `DELETE https://api.projectdiscovery.io/v1/scans/{id}/schedule`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#delete-scan-schedule)

- **Delete Scan Vulnerability**  
  `DELETE https://api.projectdiscovery.io/v1/scans/{scanId}/vulnerabilities/{vulnId}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#delete-scan-vulnerability)

- **Export Filtered Scan**  
  `GET https://api.projectdiscovery.io/v1/scans/export/filtered`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#export-filtered-scan)

- **Export Scan**  
  `GET https://api.projectdiscovery.io/v1/scans/{id}/export`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#export-scan)

- **Export Scan Vulnerability**  
  `GET https://api.projectdiscovery.io/v1/scans/{scanId}/vulnerabilities/{vulnId}/export`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#export-scan-vulnerability)

- **Get All Scan Stats**  
  `GET https://api.projectdiscovery.io/v1/scans/stats`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-all-scan-stats)

- **Get All Scans History**  
  `GET https://api.projectdiscovery.io/v1/scans/history`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-all-scans-history)

- **Get Scan**  
  `GET https://api.projectdiscovery.io/v1/scans/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scan)

- **Get Scan Config**  
  `GET https://api.projectdiscovery.io/v1/scans/{id}/config`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scan-config)

- **Get Scan History**  
  `GET https://api.projectdiscovery.io/v1/scans/{id}/history`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scan-history)

- **Get Scan IPs**  
  `GET https://api.projectdiscovery.io/v1/scans/ips`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scan-ips)

- **Get Scan List**  
  `GET https://api.projectdiscovery.io/v1/scans`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scan-list)

- **Get Scan Schedules**  
  `GET https://api.projectdiscovery.io/v1/scans/schedules`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scan-schedules)

- **Get Scans Token**  
  `GET https://api.projectdiscovery.io/v1/scans/token`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#get-scans-token)

- **Import OSS Scan**  
  `POST https://api.projectdiscovery.io/v1/scans/oss/import`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#import-oss-scan)

- **Rescan Scan**  
  `POST https://api.projectdiscovery.io/v1/scans/{id}/rescan`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#rescan-scan)

- **Retest Vulnerability**  
  `POST https://api.projectdiscovery.io/v1/scans/{scanId}/vulnerabilities/{vulnId}/retest`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#retest-vulnerability)

- **Set Scan Schedule**  
  `POST https://api.projectdiscovery.io/v1/scans/schedules`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#set-scan-schedule)

- **Stop Scan**  
  `POST https://api.projectdiscovery.io/v1/scans/{id}/stop`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#stop-scan)

- **Update Imported Scan**  
  `PUT https://api.projectdiscovery.io/v1/scans/{id}/imported`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#update-imported-scan)

- **Update Scan**  
  `PUT https://api.projectdiscovery.io/v1/scans/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#update-scan)

- **Update Scan Config**  
  `PUT https://api.projectdiscovery.io/v1/scans/{id}/config`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#update-scan-config)

- **Update Vulnerability Labels**  
  `PUT https://api.projectdiscovery.io/v1/scans/{scanId}/vulnerabilities/labels`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#update-vulnerability-labels)

- **Update Vulnerability Status**  
  `PUT https://api.projectdiscovery.io/v1/scans/{scanId}/vulnerabilities/status`  
  [Docs](https://docs.projectdiscovery.io/api-reference/scans#update-vulnerability-status)

### Results Endpoints
- **Get All Results**  
  `GET https://api.projectdiscovery.io/v1/results`  
  [Docs](https://docs.projectdiscovery.io/api-reference/results#get-all-results)

- **Get Results Stats**  
  `GET https://api.projectdiscovery.io/v1/results/stats`  
  [Docs](https://docs.projectdiscovery.io/api-reference/results#get-results-stats)

- **Get Scan Results**  
  `GET https://api.projectdiscovery.io/v1/scans/{id}/results`  
  [Docs](https://docs.projectdiscovery.io/api-reference/results#get-scan-results)

- **Get Scan Vulnerability**  
  `GET https://api.projectdiscovery.io/v1/scans/{scanId}/vulnerabilities/{vulnId}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/results#get-scan-vulnerability)

- **Get Scans Result Filters**  
  `GET https://api.projectdiscovery.io/v1/results/filters`  
  [Docs](https://docs.projectdiscovery.io/api-reference/results#get-scan-result-filters)

### Templates Endpoints
- **Create Template**  
  `POST https://api.projectdiscovery.io/v1/templates`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#create-template)

- **Delete Template**  
  `DELETE https://api.projectdiscovery.io/v1/templates/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#delete-template)

- **Generate AI Template**  
  `POST https://api.projectdiscovery.io/v1/templates/ai/generate`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#generate-ai-template)

- **Get Early Template**  
  `GET https://api.projectdiscovery.io/v1/templates/early/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-early-template)

- **Get Early Template List**  
  `GET https://api.projectdiscovery.io/v1/templates/early`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-early-template-list)

- **Get GitHub Template**  
  `GET https://api.projectdiscovery.io/v1/templates/github/{name}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-github-template)

- **Get GitHub Template List**  
  `GET https://api.projectdiscovery.io/v1/templates/github`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-github-template-list)

- **Get Public Template**  
  `GET https://api.projectdiscovery.io/v1/templates/public/{name}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-public-template)

- **Get Public Template List**  
  `GET https://api.projectdiscovery.io/v1/templates/public`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-public-template-list)

- **Get Public Template Stats**  
  `GET https://api.projectdiscovery.io/v1/templates/public/stats`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-public-template-stats)

- **Get Share Status**  
  `GET https://api.projectdiscovery.io/v1/templates/share/status`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-share-status)

- **Get Shared Template**  
  `GET https://api.projectdiscovery.io/v1/templates/shared/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-shared-template)

- **Get Template**  
  `GET https://api.projectdiscovery.io/v1/templates/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-template)

- **Get Template List**  
  `GET https://api.projectdiscovery.io/v1/templates`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#get-template-list)

- **Share Template**  
  `POST https://api.projectdiscovery.io/v1/templates/{id}/share`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#share-template)

- **Update Template**  
  `PUT https://api.projectdiscovery.io/v1/templates/{id}`  
  [Docs](https://docs.projectdiscovery.io/api-reference/templates#update-template)

### Logs Endpoints
- **Get Audit Logs for Team**  
  `GET https://api.projectdiscovery.io/v1/logs/audit/team`  
  [Docs](https://docs.projectdiscovery.io/api-reference/logs#get-audit-logs)

### Users Endpoints
- **Get User Profile**  
  `GET https://api.projectdiscovery.io/v1/users/profile`  
  [Docs](https://docs.projectdiscovery.io/api-reference/users#get-user-profile)

- **Get API Key**  
  `GET https://api.projectdiscovery.io/v1/users/api-key`  
  [Docs](https://docs.projectdiscovery.io/api-reference/users#get-api-key)

- **Create API Key**  
  `POST https://api.projectdiscovery.io/v1/users/api-key`  
  [Docs](https://docs.projectdiscovery.io/api-reference/users#create-api-key)

- **Delete API Key**  
  `DELETE https://api.projectdiscovery.io/v1/users/api-key`  
  [Docs](https://docs.projectdiscovery.io/api-reference/users#delete-api-key)

- **Rotate API Key**  
  `POST https://api.projectdiscovery.io/v1/users/api-key/rotate`  
  [Docs](https://docs.projectdiscovery.io/api-reference/users#rotate-api-key)

## Documentation
For comprehensive guidance and detailed instructions, refer to the following sections on ProjectDiscovery’s documentation site:

- **Introduction**  
  [ProjectDiscovery Overview](https://docs.projectdiscovery.io/introduction)

- **Quickstart Guide**  
  [Getting Started](https://docs.projectdiscovery.io/quickstart)

- **Open Source Tools**  
  [Tools Documentation](https://docs.projectdiscovery.io/open-source)

- **Nuclei Templates**  
  [Templates Documentation](https://docs.projectdiscovery.io/nuclei-templates)

- **Cloud Platform**  
  [PD Cloud Documentation](https://docs.projectdiscovery.io/cloud)

- **API Reference**  
  [API Docs](https://docs.projectdiscovery.io/api-reference)

- **Getting Help**  
  [Support and Community](https://docs.projectdiscovery.io/support)

---

*Note: All endpoint URLs and documentation links reflect the current structure of ProjectDiscovery’s services. For the latest updates, please visit [ProjectDiscovery Documentation](https://docs.projectdiscovery.io) and 
[ProjectDiscovery GitHub](https://github.com/projectdiscovery).*