nuclei/docs/editor/api/scan.mdx
Max K c952c57f84
Fix typos in "Getting Started" page (#4169)
* misc docs update

* Added initial API docs

* version update

* dark mode fixes!

* Fix typos in running.mdx

---------

Co-authored-by: sandeep <8293321+ehsandeep@users.noreply.github.com>
2023-09-20 00:10:23 +05:30

20 lines
529 B
Plaintext

---
title: "Scan Template"
description: "Scan target host using a specified nuclei template."
api: "POST https://templates-api.nuclei.sh/v1/template/user/scan"
version: 'v1'
---
## Parameters (required)
<ParamField body="target" type="string" required>
Target host to scan using nuclei template.
**Constraints**: Valid hostname or IP address or URL.
</ParamField>
<ParamField body="template_base64" type="string" required>
Base64 encoded nuclei template.
**Constraints**: Valid Base64 encoded template.
</ParamField>