---
title: "Scan Template"
method: PUT
path: "/api/3/scan_templates/{id}"
tags: ["Scan Template"]
---
# Scan Template
`PUT /api/3/scan_templates/{id}`
Updates a scan template.
## Path parameters
- `id` string, required
## Request body
- ScanTemplate — The details of the scan template.
- `checks` ScanTemplateVulnerabilityChecks — Settings for which vulnerability checks to run during a scan.
The rules for inclusion of checks is as follows: - Enabled checks by category and by check type are included
- Disabled checks in by category and by check type are removed
- Enabled checks in by individual check are added (even if they are disabled in by category or check type)
- Disabled checks in by individual check are removed
- If unsafe is disabled, unsafe checks are removed
- If potential is disabled, potential checks are removed
- `categories` ScanTemplateVulnerabilityCheckCategories — The vulnerability check categories enabled or disabled during a scan.
- `disabled` string[] — The categories of vulnerability checks to disable during a scan.
- `enabled` string[] — The categories of vulnerability checks to enable during a scan.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `correlate` boolean — Whether an extra step is performed at the end of the scan where more trust is put in OS patch checks to attempt to override the results of other checks which could be less reliable.
- `individual` ScanTemplateVulnerabilityCheckIndividual — The individual vulnerability checks enabled or disabled during a scan.
- `disabled` object[] — The individual vulnerability checks to disable during a scan.
- `enabled` object[] — The individual vulnerability checks to enable during a scan.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `potential` boolean — Whether checks that result in potential vulnerabilities are assessed during a scan.
- `types` VulnerabilityCheckType — The vulnerability check types enabled or disabled during a scan.
- `disabled` string[] — The types of vulnerability checks to disable during a scan.
- `enabled` string[] — The types of vulnerability checks to enable during a scan.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `unsafe` boolean — Whether checks considered "unsafe" are assessed during a scan.
- `database` ScanTemplateDatabase — Settings for discovery databases.
- `db2` string — Database name for DB2 database instance.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `oracle` string[] — Database name (SID) for an Oracle database instance.
- `postgres` string — Database name for PostgesSQL database instance.
- `description` string — A verbose description of the scan template..
- `discovery` ScanTemplateDiscovery — Discovery settings used during a scan.
- `asset` ScanTemplateAssetDiscovery — Asset discovery settings used during a scan.
- `collectWhoisInformation` boolean — Whether to query Whois during discovery. Defaults to `false`.
- `fingerprintMinimumCertainty` number, double — The minimum certainty required for a fingerprint to be considered valid during a scan. Defaults to `0.16`.
- `fingerprintRetries` integer — The number of fingerprinting attempts made to determine the operating system fingerprint. Defaults to `4`.
- `ipFingerprintingEnabled` boolean — Whether to fingerprint TCP/IP stacks for hardware, operating system and software information.
- `sendArpPings` boolean — Whether ARP pings are sent during asset discovery. Defaults to `true`.
- `sendIcmpPings` boolean — Whether ICMP pings are sent during asset discovery. Defaults to `false`.
- `tcpPorts` integer[] — TCP ports to send packets and perform discovery. Defaults to no ports.
- `treatTcpResetAsAsset` boolean — Whether TCP reset responses are treated as live assets. Defaults to `true`.
- `udpPorts` integer[] — UDP ports to send packets and perform discovery. Defaults to no ports.
- `performance` ScanTemplateDiscoveryPerformance — Discovery performance settings used during a scan.
- `packetRate` ScanTemplateDiscoveryPerformancePacketsRate — The number of packets to send per second during scanning.
- `defeatRateLimit` boolean — Whether defeat rate limit (defeat-rst-ratelimit) is enforced on the minimum packet setting, which can improve scan speed. If it is disabled, the minimum packet rate setting may be ignored when a target limits its rate of RST (reset) responses to a port scan. This can increase scan accuracy by preventing the scan from missing ports. Defaults to `true`.
- `maximum` integer — The minimum number of packets to send each second during discovery attempts. Defaults to `0`.
- `minimum` integer — The minimum number of packets to send each second during discovery attempts. Defaults to `0`.
- `parallelism` ScanTemplateDiscoveryPerformanceParallelism — The number of discovery connection requests to be sent to target host simultaneously. These settings has no effect if values have been set for `scanDelay`.
- `maximum` integer — The maximum number of discovery connection requests send in parallel. Defaults to `0`.
- `minimum` integer — The minimum number of discovery connection requests send in parallel. Defaults to `0`.
- `retryLimit` integer — The maximum number of attempts to contact target assets. If the limit is exceeded with no response, the given asset is not scanned. Defaults to `3`.
- `scanDelay` ScanTemplateDiscoveryPerformanceScanDelay — The duration to wait between sending packets to each target host during a scan.
- `maximum` string — The minimum duration to wait between sending packets to each target host. The value is specified as a ISO8601 duration and can range from `PT0S` (0ms) to `P30S` (30s). Defaults to `PT0S`.
- `minimum` string — The maximum duration to wait between sending packets to each target host. The value is specified as a ISO8601 duration and can range from `PT0S` (0ms) to `P30S` (30s). Defaults to `PT0S`.
- `timeout` ScanTemplateDiscoveryPerformanceTimeout — The duration to wait between retry attempts.
- `initial` string — The initial timeout to wait between retry attempts. The value is specified as a ISO8601 duration and can range from `PT0.5S` (500ms) to `P30S` (30s). Defaults to `PT0.5S`.
- `maximum` string — The maximum time to wait between retries. The value is specified as a ISO8601 duration and can range from `PT0.5S` (500ms) to `P30S` (30s). Defaults to `PT3S`.
- `minimum` string — The minimum time to wait between retries. The value is specified as a ISO8601 duration and can range from `PT0.5S` (500ms) to `P30S` (30s). Defaults to `PT0.5S`.
- `service` ScanTemplateServiceDiscovery — Service discovery settings used during a scan.
- `serviceNameFile` string — An optional file that lists each port and the service that commonly resides on it. If scans cannot identify actual services on ports, service names will be derived from this file in scan results. Defaults to empty.
- `tcp` ScanTemplateServiceDiscoveryTcp — TCP service discovery settings.
- `additionalPorts` string — Additional TCP ports to scan. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `"7892-7898"`). Defaults to empty.
- `excludedPorts` string — TCP ports to exclude from scanning. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `"7892-7898"`). Defaults to empty.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `method` 'SYN' | 'SYN+RST' | 'SYN+FIN' | 'SYN+ECE' | 'Full' — The method of TCP discovery. Defaults to `SYN`.
- `ports` 'all' | 'well-known' | 'custom' | 'none' — The TCP ports to scan. Defaults to `well-known`.
- `udp` ScanTemplateServiceDiscoveryUdp — UDP service discovery settings.
- `additionalPorts` string — Additional UDP ports to scan. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `"7892-7898"`). Defaults to empty.
- `excludedPorts` string — UDP ports to exclude from scanning. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `"7892-7898"`). Defaults to empty.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `ports` 'all' | 'well-known' | 'custom' | 'none' — The UDP ports to scan. Defaults to `well-known`.
- `discoveryOnly` boolean — Whether only discovery is performed during a scan.
- `enableWindowsServices` boolean — Whether Windows services are enabled during a scan. Windows services will be temporarily reconfigured when this option is selected. Original settings will be restored after the scan completes, unless it is interrupted.
- `enhancedLogging` boolean — Whether enhanced logging is gathered during scanning. Collection of enhanced logs may greatly increase the disk space used by a scan.
- `id` string — The identifier of the scan template
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `maxParallelAssets` integer — The maximum number of assets scanned simultaneously per scan engine during a scan.
- `maxScanProcesses` integer — The maximum number of scan processes simultaneously allowed against each asset during a scan.
- `name` string — A concise name for the scan template.
- `policy` Policy — Policy configuration settings used during a scan.
- `enabled` object[] — The identifiers of the policies enabled to be checked during a scan. No policies are enabled by default.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `recursiveWindowsFSSearch` boolean — Whether recursive windows file searches are enabled, if your internal security practices require this capability. Recursive file searches can increase scan times by several hours, depending on the number of files and other factors, so this setting is disabled for Windows systems by default. Defaults to `false`.
- `storeSCAP` boolean — Whether Asset Reporting Format (ARF) results are stored. If you are required to submit reports of your policy scan results to the U.S. government in ARF for SCAP certification, you will need to store SCAP data so that it can be exported in this format. Note that stored SCAP data can accumulate rapidly, which can have a significant impact on file storage. Defaults to `false`.
- `policyEnabled` boolean — Whether policy assessment is performed during a scan.
- `telnet` Telnet — Settings for interacting with the Telnet protocol.
- `characterSet` string — The character set to use.
- `failedLoginRegex` string — Regular expression to match a failed login response.
- `links` Link[], required — Hypermedia links to corresponding or related resources.
- `deprecation` string
- `href` string — A hypertext reference, which is either a URI (see RFC 3986) or URI template (see RFC 6570).
- `hreflang` string
- `media` string
- `rel` string — The link relation type. This value is one from the Link Relation Type Registry or is the type of resource being linked to.
- `title` string
- `type` string
- `loginRegex` string — Regular expression to match a login response.
- `passwordPromptRegex` string — Regular expression to match a password prompt.
- `questionableLoginRegex` string — Regular expression to match a potential false negative login response.
- `vulnerabilityEnabled` boolean — Whether vulnerability assessment is performed during a scan.
- `web` object — Web spider settings used during a scan.
- `webEnabled` boolean — Whether web spidering and assessment are performed during a scan.
## Response `200`
OK
## Other responses
- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable
---
[API](https://skmtc.net/rapid7/apis/rapid7-vm-api.md) · [All operations](https://skmtc.net/rapid7/apis/rapid7-vm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapid7/rapid7-vm-api/versions/3a8197c22d71/schema)