mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "ProjectDiscovery Documentation",
  "primaryTab": {
    "name": "Getting Started"
  },
  "logo": {
    "dark": "/logo/ProjectDiscovery-Logo-OnDark.svg",
    "light": "/logo/ProjectDiscovery-Logo-OnLight.svg"
  },
  "analytics": {
    "fathom": {
      "siteId": "ICPEDSUC"
    },
    "posthog": {
      "apiKey": "phc_qgncJdQ3xs8FggnVsWkFokoej0Kk12czhKuArgNDMlQ"
    }
  },
  "openapi": "openapi.yaml",
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#9563FF",
    "light": "#6366f1",
    "dark": "#0D001D",
    "background": {
      "dark": "#09090b"
    },
    "anchors": {
      "from": "#FF7F57",
      "to": "#9563FF"
    }
  },
  "topbarLinks": [
    {
      "name": "Try our Platform",
      "url": "https://cloud.projectdiscovery.io/"
    }
  ],
  "topbarCtaButton": {
    "type": "github",
    "url": "https://github.com/projectdiscovery/nuclei"
  },
  "tabs": [
    {
      "name": "Tools",
      "url": "tools"
    },
    {
      "name": "Templates",
      "url": "templates"
    },
    {
      "name": "Cloud Platform",
      "url": "cloud"
    },
    {
      "name": "API",
      "url": "api-reference"
    },
    {
      "name": "Help",
      "url": "help"
    }
  ],
  "anchors": [
    {
      "name": "Documentation Home",
      "icon": "book-open-cover",
      "url": "https://docs.projectdiscovery.io"
    },
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://projectdiscovery.io/community"
    }
  ],
  "navigation": [
    {
      "group": "Welcome",
      "pages": ["introduction", "documentation-nav", "overview"]
    },
    {
      "group": "New to Open Source?",
      "pages": [
        "getstarted-overview",
        "getstarted-example",
        "getstarted-nextsteps"
      ]
    },
    {
      "group": "ProjectDiscovery Cloud Platform",
      "pages": ["cloudplatform"]
    },
    {
      "group": "Tools",
      "pages": [
        "tools/index",
        {
          "group": "AlterX",
          "icon": "cloud-word",
          "iconType": "duotone",
          "pages": [
            "tools/alterx/overview",
            "tools/alterx/install",
            "tools/alterx/usage",
            "tools/alterx/running"
          ]
        },
        {
          "group": "Chaos",
          "icon": "globe",
          "iconType": "duotone",
          "pages": [
            "tools/chaos/overview",
            "tools/chaos/install",
            "tools/chaos/usage",
            "tools/chaos/running"
          ]
        },
        {
          "group": "Cloudlist",
          "icon": "cloud",
          "iconType": "duotone",
          "pages": [
            "tools/cloudlist/overview",
            "tools/cloudlist/install",
            "tools/cloudlist/usage",
            "tools/cloudlist/providers",
            "tools/cloudlist/running"
          ]
        },
        {
          "group": "cvemap",
          "icon": "signs-post",
          "iconType": "solid",
          "pages": [
            "tools/cvemap/overview",
            "tools/cvemap/install",
            "tools/cvemap/usage",
            "tools/cvemap/running"
          ]
        },
        {
          "group": "dnsx",
          "icon": "tags",
          "iconType": "duotone",
          "pages": [
            "tools/dnsx/overview",
            "tools/dnsx/install",
            "tools/dnsx/usage",
            "tools/dnsx/running"
          ]
        },
        {
          "group": "httpx",
          "icon": "browser",
          "iconType": "duotone",
          "pages": [
            "tools/httpx/overview",
            "tools/httpx/install",
            "tools/httpx/usage",
            "tools/httpx/running"
          ]
        },
        {
          "group": "Interactsh",
          "icon": "whistle",
          "iconType": "duotone",
          "pages": [
            "tools/interactsh/overview",
            "tools/interactsh/install",
            "tools/interactsh/usage",
            "tools/interactsh/running",
            "tools/interactsh/integrations",
            "tools/interactsh/server"
          ]
        },
        {
          "group": "Katana",
          "icon": "sword",
          "iconType": "duotone",
          "pages": [
            "tools/katana/overview",
            "tools/katana/install",
            "tools/katana/usage",
            "tools/katana/running"
          ]
        },
        {
          "group": "Naabu",
          "icon": "person-to-portal",
          "iconType": "duotone",
          "pages": [
            "tools/naabu/overview",
            "tools/naabu/install",
            "tools/naabu/usage",
            "tools/naabu/running"
          ]
        },
        {
          "group": "Notify",
          "icon": "bell",
          "iconType": "duotone",
          "pages": [
            "tools/notify/overview",
            "tools/notify/install",
            "tools/notify/usage",
            "tools/notify/provider-config",
            "tools/notify/running"
          ]
        },
        {
          "group": "Nuclei",
          "icon": "atom",
          "iconType": "regular",
          "pages": [
            "tools/nuclei/overview",
            "tools/nuclei/install",
            "tools/nuclei/running",
            "tools/nuclei/input-formats",
            "tools/nuclei/authenticated-scans",
            "tools/nuclei/mass-scanning-cli",
            "tools/nuclei/nuclei-sdk",
            "tools/nuclei/faq"
          ]
        },
        {
          "group": "PDTM",
          "icon": "toolbox",
          "iconType": "regular",
          "pages": [
            "tools/pdtm/overview",
            "tools/pdtm/install",
            "tools/pdtm/usage",
            "tools/pdtm/running"
          ]
        },
        {
          "group": "Subfinder",
          "icon": "radar",
          "iconType": "duotone",
          "pages": [
            "tools/subfinder/overview",
            "tools/subfinder/install",
            "tools/subfinder/usage",
            "tools/subfinder/running"
          ]
        },
        {
          "group": "uncover",
          "icon": "telescope",
          "iconType": "duotone",
          "pages": [
            "tools/uncover/overview",
            "tools/uncover/install",
            "tools/uncover/usage",
            "tools/uncover/running"
          ]
        }  
      ]
    },
    {
      "group": "Templates",
      "pages": [
        "templates/introduction",
        "templates/structure",
        "templates/faq"
      ]
    },
    {
      "group": "Protocols",
      "pages": [
        {
          "group": "HTTP",
          "icon": "globe",
          "iconType": "solid",
          "pages": [
            "templates/protocols/http/basic-http",
            "templates/protocols/http/raw-http",
            {
              "group": "HTTP Fuzzing",
              "pages": [
                "templates/protocols/http/fuzzing-overview",
                "templates/protocols/http/fuzzing-examples"

              ]
            },
            {
              "group": "HTTP Payloads",
              "pages": [
                "templates/protocols/http/http-payloads",
                "templates/protocols/http/http-payloads-examples"
              ]
            },
            {
              "group": "Advanced HTTP",
              "pages": [
                "templates/protocols/http/unsafe-http",
                "templates/protocols/http/value-sharing",
                "templates/protocols/http/connection-tampering",
                "templates/protocols/http/request-tampering",
                "templates/protocols/http/race-conditions"
              ]
            }
          ]
        },
        "templates/protocols/headless",
        "templates/protocols/network",
        "templates/protocols/dns",
        "templates/protocols/file",
        {
          "group": "JavaScript",
          "icon": "square-js",
          "iconType": "solid",
          "pages": [
            "templates/protocols/javascript/introduction",
            "templates/protocols/javascript/protocol",
            {
              "group": "Modules",
              "iconType": "solid",
              "pages": [
                "templates/protocols/javascript/modules/bytes",
                "templates/protocols/javascript/modules/fs",
                "templates/protocols/javascript/modules/ikev2",
                "templates/protocols/javascript/modules/kerberos",
                "templates/protocols/javascript/modules/ldap",
                "templates/protocols/javascript/modules/mssql",
                "templates/protocols/javascript/modules/mysql",
                "templates/protocols/javascript/modules/net",
                "templates/protocols/javascript/modules/oracle",
                "templates/protocols/javascript/modules/pop3",
                "templates/protocols/javascript/modules/postgres",
                "templates/protocols/javascript/modules/rdp",
                "templates/protocols/javascript/modules/redis",
                "templates/protocols/javascript/modules/rsync",
                "templates/protocols/javascript/modules/smb",
                "templates/protocols/javascript/modules/smtp",
                "templates/protocols/javascript/modules/ssh",
                "templates/protocols/javascript/modules/structs",
                "templates/protocols/javascript/modules/telnet",
                "templates/protocols/javascript/modules/vnc"
              ]
            }
          ]
        },
        "templates/protocols/code",
        "templates/protocols/flow",
        "templates/protocols/multi-protocol"
      ]
    },
    {
      "group": "Reference",
      "pages": [
        "templates/reference/matchers",
        "templates/reference/extractors",
        "templates/reference/variables",
        "templates/reference/helper-functions",
        "templates/reference/js-helper-functions",
        "templates/reference/preprocessors",
        "templates/reference/template-signing",
        "templates/reference/oob-testing"
      ]
    },
    {
      "group": "Workflows",
      "pages": ["templates/workflows/overview", "templates/workflows/examples"]
    },
    {
      "group": "ProjectDiscovery Cloud Platform",
      "pages": ["cloud/introduction", "cloud/features", "cloud/general-faq", "cloud/usecases"]
    },
    {
      "group": "Use Cases",
      "pages": ["cloud/examples/addassets", "cloud/examples/continuousscan", "cloud/examples/customautomation", "cloud/examples/trending"]
    },
    {
      "group": "Assets",
      "pages": ["cloud/assets/overview", "cloud/assets/adding-assets"]
    }, 
    { "group": "Templates & Editor",
      "pages": ["cloud/editor/overview", "cloud/editor/faq",
       {
        "group": "Editor",
        "pages": [
           "cloud/editor/ai",
           "cloud/editor/share",
           "cloud/editor/shortcuts"
          ]
        },
        "cloud/editor/recommended"
      ]
    }, 
    {
      "group": "Scanning",
      "pages": ["cloud/scanning/overview", "cloud/scanning/nuclei-scan", "cloud/scanning/createscans", "cloud/scanning/integrations", "cloud/scanning/parameters"]
    },
    {
      "group": "API Reference",
      "pages": [
        "api-reference/introduction",
        {
          "group": "Assets",
          "pages": [
            "api-reference/assets/get-asset-list",
            "api-reference/assets/upload-asset",
            "api-reference/assets/get-asset-content",
            "api-reference/assets/delete-asset",
            "api-reference/assets/delete-enumerated-asset",
            "api-reference/assets/get-asset-metadata",
            "api-reference/assets/update-asset-metadata",
            "api-reference/assets/update-asset-content"
          ]
        },
        {
          "group": "Auto Discovery",
          "pages": [
            "api-reference/enumerations/create-enumeration",
            "api-reference/enumerations/get-enumeration",
            "api-reference/enumerations/update-enumeration",
            "api-reference/enumerations/delete-enumeration",
            "api-reference/enumerations/get-enumeration-list",
            "api-reference/enumerations/export-enumeration",
            "api-reference/enumerations/rescan-enumeration",
            "api-reference/enumerations/stop-enumeration",
            "api-reference/enumerations/get-enumeration-contents",
            "api-reference/enumerations/get-enumeration-schedules",
            "api-reference/enumerations/set-enumeration-schedule",
            "api-reference/enumerations/delete-enumeration-schedule",
            "api-reference/enumerations/get-enumeration-stats"
          ]
        },
        {
          "group": "Templates",
          "pages": [
            "api-reference/templates/create-template",
            "api-reference/templates/generate-ai-template",
            "api-reference/templates/get-template",
            "api-reference/templates/update-template",
            "api-reference/templates/delete-template",
            "api-reference/templates/get-template-list",
            "api-reference/templates/get-public-template-list",
            "api-reference/templates/get-public-template-stats",
            "api-reference/templates/get-public-template",
            "api-reference/templates/get-early-template-list",
            "api-reference/templates/get-early-template",
            "api-reference/templates/get-github-template-list",
            "api-reference/templates/get-github-template",
            "api-reference/templates/share-template",
            "api-reference/templates/get-share-status",
            "api-reference/templates/get-shared-template"
          ]
        },
        {
          "group": "Scans",
          "pages": [
            "api-reference/scans/get-scan-list",
            "api-reference/scans/create-scan",
            "api-reference/scans/get-scan",
            "api-reference/scans/get-scan-ips",
            "api-reference/scans/get-scans-token",
            "api-reference/scans/delete-scan",
            "api-reference/scans/update-scan",
            "api-reference/scans/stop-scan",
            "api-reference/scans/rescan-scan",
            "api-reference/scans/import-oss-scan",
            "api-reference/scans/update-imported-scan",
            "api-reference/scans/get-scan-schedules",
            "api-reference/scans/set-scan-schedule",
            "api-reference/scans/delete-scan-schedule",
            "api-reference/scans/get-all-scan-stats",
            "api-reference/scans/get-all-scans-history",
            "api-reference/scans/get-scan-history",
            "api-reference/scans/get-scan-config",
            "api-reference/scans/update-scan-config",
            "api-reference/scans/retest-vulnerability",
            "api-reference/scans/delete-scan-vulnerability",
            "api-reference/scans/export-scan-vulnerability",
            "api-reference/scans/export-filtered-scan",
            "api-reference/scans/export-scan",
            "api-reference/scans/create-vulns-export-to-tracker",
            "api-reference/scans/update-vulnerability-labels",
            "api-reference/scans/update-vulnerability-status"
          ]
        },
        {
          "group": "Configurations",
          "pages": [
            "api-reference/configurations/get-config",
            "api-reference/configurations/get-configs-list",
            "api-reference/configurations/add-config",
            "api-reference/configurations/update-config",
            "api-reference/configurations/delete-config",
            "api-reference/configurations/verify-config",
            "api-reference/configurations/get-excluded-templates",
            "api-reference/configurations/add-excluded-templates",
            "api-reference/configurations/delete-excluded-template-ids"
          ]
        },
        {
          "group": "Results",
          "pages": [
            "api-reference/results/get-scan-results",
            "api-reference/results/get-all-results",
            "api-reference/results/get-scan-vulnerability",
            "api-reference/results/get-scans-result-filters",
            "api-reference/results/get-results-stats"
          ]
        },
        {
          "group": "Retests",
          "pages": [
            "api-reference/retests/get-all-retest",
            "api-reference/retests/create-retest",
            "api-reference/retests/get-retest-vulnerability"
          ]
        },
        {
          "group": "Scan Logs",
          "pages": [
            "api-reference/scan_log/get-scan-log-of-given-scan-id",
            "api-reference/scan_log/download-scan-log-of-given-scan-id"
          ]
        },
        {
          "group": "Error Logs",
          "pages": [
            "api-reference/elog/get-elogs-of-given-scan-id",
            "api-reference/elog/download-elogs-of-given-scan-id"
          ]
        },
        {
          "group": "Users",
          "pages": [
            "api-reference/users/create-api-key",
            "api-reference/users/get-api-key",
            "api-reference/users/rotate-api-key",
            "api-reference/users/delete-api-key",
            "api-reference/users/get-user-profile",
            "api-reference/users/get-subscription-status",
            "api-reference/users/create-feedback",
            "api-reference/users/delete-user-from-system-along-with-all-data",
            "api-reference/users/email-user-deletion-verification-code"
          ]
        }
      ]
    },
    {
      "group": "Help",
      "pages": ["help/home"]
    }
  ],
  "footerSocials": {
    "github": "https://github.com/projectdiscovery",
    "twitter": "https://twitter.com/pdiscoveryio",
    "discord": "https://discord.com/invite/projectdiscovery",
    "linkedin": "https://www.linkedin.com/company/projectdiscovery",
    "youtube": "https://www.youtube.com/@projectdiscovery"
  },
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true
  }
}