Sign in

v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Scan Template

Scan Templates

Creates a new scan template.

post/api/3/scan_templates

Request body

descriptionstring

A verbose description of the scan template..

discoveryOnlyboolean

Whether only discovery is performed during a scan.

enableWindowsServicesboolean

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.

enhancedLoggingboolean

Whether enhanced logging is gathered during scanning. Collection of enhanced logs may greatly increase the disk space used by a scan.

idstring

The identifier of the scan template

maxParallelAssetsinteger

The maximum number of assets scanned simultaneously per scan engine during a scan.

maxScanProcessesinteger

The maximum number of scan processes simultaneously allowed against each asset during a scan.

namestring

A concise name for the scan template.

policyEnabledboolean

Whether policy assessment is performed during a scan.

vulnerabilityEnabledboolean

Whether vulnerability assessment is performed during a scan.

webobject

Web spider settings used during a scan.

webEnabledboolean

Whether web spidering and assessment are performed during a scan.

Example request

{
  "checks": {
    "categories": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    },
    "individual": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    },
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ],
    "types": {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    }
  },
  "database": {
    "db2": "database",
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ],
    "oracle": [
      "default"
    ],
    "postgres": "postgres"
  },
  "description": "Performs a full network audit of all systems using only safe checks...",
  "discovery": {
    "asset": {
      "fingerprintMinimumCertainty": 0.16,
      "ipFingerprintingEnabled": true,
      "sendArpPings": true,
      "sendIcmpPings": true,
      "treatTcpResetAsAsset": true
    },
    "performance": {
      "packetRate": {
        "defeatRateLimit": true,
        "maximum": 15000,
        "minimum": 450
      },
      "retryLimit": 3,
      "scanDelay": {
        "maximum": "PT0S",
        "minimum": "PT0S"
      },
      "timeout": {
        "initial": "PT0.5S",
        "maximum": "PT3S",
        "minimum": "PT0S"
      }
    },
    "service": {
      "tcp": {
        "additionalPorts": "3078,8000-8080",
        "excludedPorts": "1024",
        "links": [
          {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
          }
        ],
        "method": "SYN",
        "ports": "well-known"
      },
      "udp": {
        "additionalPorts": "4020-4032",
        "excludedPorts": "9899",
        "links": [
          {
            "href": "https://hostname:3780/api/3/...",
            "rel": "self"
          }
        ],
        "ports": "well-known"
      }
    }
  },
  "id": "full-audit-without-web-spider",
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "maxParallelAssets": 10,
  "maxScanProcesses": 10,
  "name": "Full audit",
  "policy": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "policyEnabled": true,
  "telnet": {
    "characterSet": "ASCII",
    "failedLoginRegex": "(?:[i,I]ncorrect|[u,U]nknown|[f,F]ail|[i,I]nvalid|[l,L]ogin|[p,P]assword|[p,P]asswd|[u,U]sername|[u,U]nable|[e,E]rror|[d,D]enied|[r,R]eject|[r,R]efuse|[c,C]lose|[c,C]losing|Not on system console|% Bad)",
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ],
    "loginRegex": "(?:[l,L]ogin|[u,U]ser.?[nN]ame) *\\:",
    "passwordPromptRegex": "(?:[p,P]assword|[p,P]asswd) *\\:",
    "questionableLoginRegex": "(?:[l,L]ast [l,L]ogin *\\:|allows only .* Telnet Client License)"
  },
  "vulnerabilityEnabled": true
}

Response

OK