openapi: 3.1.0
info:
  title: InsightAppSec Accounts Scan Template API
  description: '<p>Welcome to the reference documentation for the public APIs available for InsightAppSec.</p><p>Here are a few resources to help you learn how to start using our APIs:</p><ul><li><a href=''https://insight.help.rapid7.com/docs/api-overview''>Learn about basic concepts and capabilities</a></li><li><a href=''https://insight.help.rapid7.com/docs/managing-platform-api-keys''>Get an Insight platform API key to set up authentication</a></li><li><a href=''https://insight.help.rapid7.com/docs/product-apis''>See available Insight product APIs</a></li><li><a href=''https://insightappsec.help.rapid7.com/docs''>Learn more about InsightAppSec</a></li></ul><p>After you''ve got the basics down, you can use this API guide to find examples of requests and responses.</p></p><h2>Permissions</h2><p>This API uses the platform role of a user''s API key to inherit a set of permissions.</p><p><b>Notes</b>:<li>Platform Admins do not require explicit access to an App in order to see it, or anything associated with it</li><li>Organization keys will inherit Product Admin permissions.</li></p><table><thead><tr><th>Role</th><th>Permissions</th></tr></thead><tbody><tr><td>Product Admin</td><td><li><code>Manage Apps</code></li><li><code>Read Attack Templates</code></li><li><code>Manage Targets</code><li><code>Manage Scan Configs</code><li><code>Manage Scans</code></li><li><code>Manage Vulnerabilities</code></li><li><code>Administer Vulnerability Comments</code></li><li><code>Manage Engines</code></li><li><code>Manage Engine Groups</code></li><li><code>Manage Schedules</code></li><li><code>Manage Blackouts</code></li><li><code>Manage Global Blackouts</code></li><li><code>Manage Files</code></li><li><code>Manage Tags</code></li><li><code>Manage PDF Report</code></li></td></tr><tr><td>Read Write</td><td><li><code>Manage Apps</code></li><li><code>Read Attack Templates</code></li><li><code>Read Targets</code><li><code>Manage Scan Configs</code><li><code>Manage Scans</code></li><li><code>Manage Vulnerabilities</code></li><li><code>Manage Vulnerability Comments</code></li><li><code>Read Engines</code></li><li><code>Read Engine Groups</code></li><li><code>Manage Schedules</code></li><li><code>Manage Blackouts</code></li><li><code>Manage Files</code></li><li><code>Manage Tags</code></li><li><code>Manage PDF Report</code></li></td></tr><tr><td>Read Only</td><td><li><code>Read Apps</code></li><li><code>Read Attack Templates</code></li><li><code>Read Targets</code><li><code>Read Scan Configs</code><li><code>Read Scans</code></li><li><code>Read Vulnerabilities</code></li><li><code>Read Vulnerability Comments</code></li><li><code>Read Engines</code></li><li><code>Read Engine Groups</code></li><li><code>Read Schedules</code></li><li><code>Read Blackouts</code></li><li><code>Read Files</code></li><li><code>Read Tags</code></li><li><code>Read PDF Report</code></li></td></tr></tbody><table><a href="#pagination"><h2 id="pagination">Pagination Parameters</h2></a><p>The following query parameters can be used to control the order, offset and size of the returned data</p><table><thead><tr><th>Parameter</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>index</code></td><td><p>The 0-based index of the page of data desired (default: 0)<p></td><td><code>?index=2</code></td></tr><tr><td><code>size</code></td><td><p>The size of the page of data desired (min: 1, max: 1000, default: 50)<p></td><td><code>?size=10</code></td></tr><tr><td><code>sort</code></td><td><p>The sort terms and (optional) directions for the desired ordering of data (default: specific to each resource)<p></td><td><code>?sort=scan.submit_time,DESC,scan.status</code></td></tr><tr><td><code>page-token</code></td><td><p>The page token, used as an alternative to <code>index</code> (default: Not provided)<p></td><td><code>?page-token=NDM0NTk0NTIyOjo6X1M6OjpiYW5hbmFz</code></td></tr></tbody></table><h3>Paging using a page token</h3><p>When intending to page beyond the 10,000th result, or as an alternative to using the <code>index</code> query parameter, the <code>page-token</code> option may be used instead. After retrieving the first page, the <code>page_token</code> will be present in the <code>metadata</code> section of the response.<br />For example, with <code>size=99</code>, <code>index=0</code> to <code>index=99</code> may be used. To load the next page, use the <code>page_token</code> value used in the response e.g. <code>?page-token=NDM0NTk0NTIyO</code> </p><h2>Creating resources</h2><p>As is generally the accepted practice with REST-ful APIs, creating a resource can be performed by sending an appropriately formatted POST request. Any ID provided for a new resource in a POST request <i>body</i> will simply be ignored (and a new one generated internally and returned as part of the resource in subsequent GET requests), and POST requests to URLs following a format similar to <code>.../resource/<ID></code> are unsupported and should respond with <code>415 Method Not Allowed</code>. All requests which successfully create a resource and respond with <code>201 Created</code> will contain a <code>Location</code> header the value of which is an absolute URI for the resource (the ID of which can be determined as the last section of the path in the given URI). For example:<br /><code>Location: https://us.api.insight.rapid7.com/ias/v1/scans/12345678-1234-5678-90AB-1234567890AB</code></p><h2>Date, Time and Timezone Support</h2><p>The value of date and date-time type properties are fixed to the common ISO-8601 format. Unless otherwise specified, all date or date-time data in response bodies are expressed in UTC, and it is also expected that data provided in request bodies are also expressed in UTC.</p><h3>Schedules and Blackouts</h3><p>The <code>first_start</code> and <code>first_end</code> properties of both Blackouts and Schedules, and the <code>last_start</code> property of Blackouts may be specified with a timezone. If the timezone is not specified, it is assumed to be UTC. For example:<br /><code>2019-08-12T14:00:00.000000Z[Asia/Tokyo]</code><br />It is also possible to specify the timezone as an offset of either <code>GMT</code> or <code>UTC</code>. For example:<br /><code>2019-09-04T15:00:00.000000Z[GMT+03:00]</code></p><table><thead><tr><th>Value</th><th>Format</th><th>Notes</th></tr></thead><tbody><tr><td>Date</td><td>YYYY-MM-DD</td><td>Defaults to 12 am UTC (if used for a date &amp; time)</td></tr><tr><td>Date &amp; time only</td><td>YYYY-MM-DD''T''hh:mm:ss[.nnn]</td><td>Defaults to UTC</td></tr><tr><td>Date &amp; time in UTC</td><td>YYYY-MM-DD''T''hh:mm:ss[.nnn]Z</td><td></td></tr><tr><td>Date &amp; time with specific timezone</td><td>YYYY-MM-DD''T''hh:mm:ss[.nnn]Z[TimeZoneId]</td><td></td></tr></tbody></table><h2>Searching and Filtering</h2><p>One characteristic of a powerful API is support for complex search and filtering of resources using a flexible query language. It is entirely possible to provide basic search and filtering functionality on standard GET resource collection operations using HTTP query parameters, but this becomes restrictive when attempting to encode boolean logic. Other solutions are also possible but come with equally restrictive compromises. The most effective way to facilitate this complex search and filtering is to provide it as a top-level API with a robust Domain-Specific Language (DSL).</p><p>For simple data retrieval that supports paging and sorting functionality, use the traditional resource-specific GET collection operations; for more complex data retrieval that supports a user-crafted query DSL, use the global Search operation.</p><h2>Errors</h2><p>Any response from the API with an HTTP Status Code in the 4xx or 5xx range indicates an error. If in the 4xx range it indicates a client-side error, where in the 5xx range it indicates a server-side error. All responses indicating an error should be JSON formatted, and contain both a "status" and a "message" property indicating the cause of the error, a "r7-correlation-id" header should also always be returned in the format of a UUID, which uniquely identifies the HTTP exchange that took place and caused the error (this header is present on <i>every</i> request). On some occasions, an "error_code" property will be included in the response body, which can provide the support team further context into the cause of the error in cases where the message is not explicitly clear.</p><p>When contacting support about error responses received from the API, please attempt to include, at minimum:<ul><li>A description of the requests intent</li><li>The request URL</li><li>The request body</li><li>The error response body</li><li>The error response "r7-correlation-id" header</li></ul></p><h3>Validation Errors</h3><p>Specifically, when a response with an HTTP Status Code of 422 is returned, this indicates a validation error, almost always received in a response from a non-idempotent request (normally PUT, POST or DELETE). In this case, there should be an additional "errors" property included in the JSON response body that should describe the cause of the validation exception; this will almost always require a modification to the request body to resolve. </p>'
  version: v1
servers:
- url: https://[region].api.insight.rapid7.com/ias/v1
tags:
- name: Scan Template
  description: Scan Template Resource Controller
paths:
  /api/3/scan_templates:
    get:
      tags:
      - Scan Template
      summary: Scan Templates
      description: Returns all scan templates.
      operationId: getScanTemplates
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters: []
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«ScanTemplate»'
          examples: {}
          headers: {}
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/UnauthorizedError'
          examples: {}
          headers: {}
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/NotFoundError'
          examples: {}
          headers: {}
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
          examples: {}
          headers: {}
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableError'
          examples: {}
          headers: {}
      security: []
    post:
      tags:
      - Scan Template
      summary: Scan Templates
      description: Creates a new scan template.
      operationId: createScanTemplate
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanTemplate
        description: The details of the scan template.
        required: false
        schema:
          $ref: '#/definitions/ScanTemplate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CreatedReference«ScanTemplateID,Link»'
          examples: {}
          headers: {}
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/BadRequestError'
          examples: {}
          headers: {}
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/UnauthorizedError'
          examples: {}
          headers: {}
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
          examples: {}
          headers: {}
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableError'
          examples: {}
          headers: {}
      security: []
  /api/3/scan_templates/{id}:
    get:
      tags:
      - Scan Template
      summary: Scan Template
      description: Returns a scan template.
      operationId: getScanTemplate
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the scan template
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ScanTemplate'
          examples: {}
          headers: {}
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/UnauthorizedError'
          examples: {}
          headers: {}
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/NotFoundError'
          examples: {}
          headers: {}
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
          examples: {}
          headers: {}
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableError'
          examples: {}
          headers: {}
      security: []
    put:
      tags:
      - Scan Template
      summary: Scan Template
      description: Updates a scan template.
      operationId: updateScanTemplate
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the scan template
        required: true
        type: string
      - in: body
        name: scanTemplate
        description: The details of the scan template.
        required: false
        schema:
          $ref: '#/definitions/ScanTemplate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Links'
          examples: {}
          headers: {}
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/BadRequestError'
          examples: {}
          headers: {}
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/UnauthorizedError'
          examples: {}
          headers: {}
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/NotFoundError'
          examples: {}
          headers: {}
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
          examples: {}
          headers: {}
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableError'
          examples: {}
          headers: {}
      security: []
    delete:
      tags:
      - Scan Template
      summary: Scan Template
      description: Deletes a scan template.
      operationId: deleteScanTemplate
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the scan template
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Links'
          examples: {}
          headers: {}
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/UnauthorizedError'
          examples: {}
          headers: {}
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/NotFoundError'
          examples: {}
          headers: {}
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/InternalServerError'
          examples: {}
          headers: {}
        '503':
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ServiceUnavailableError'
          examples: {}
          headers: {}
      security: []
definitions:
  ScanTemplateDiscoveryPerformanceParallelism:
    type: object
    properties:
      maximum:
        type: integer
        format: int32
        example: 0
        description: The maximum number of discovery connection requests send in parallel. Defaults to `0`.
        minimum: 0
        maximum: 1000
      minimum:
        type: integer
        format: int32
        example: 0
        description: The minimum number of discovery connection requests send in parallel. Defaults to `0`.
        minimum: 0
        maximum: 1000
    description: ''
  NotFoundError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '404'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '404'
    description: ''
  InternalServerError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '500'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '500'
    description: ''
  ScanTemplateVulnerabilityChecks:
    type: object
    properties:
      categories:
        example: ''
        description: The vulnerability check categories enabled or disabled during a scan.
        $ref: '#/definitions/ScanTemplateVulnerabilityCheckCategories'
      correlate:
        type: boolean
        example: false
        description: 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:
        example: ''
        description: The individual vulnerability checks enabled or disabled during a scan.
        $ref: '#/definitions/ScanTemplateVulnerabilityCheckIndividual'
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      potential:
        type: boolean
        example: false
        description: Whether checks that result in potential vulnerabilities are assessed during a scan.
      types:
        example: ''
        description: The vulnerability check types enabled or disabled during a scan.
        $ref: '#/definitions/VulnerabilityCheckType'
      unsafe:
        type: boolean
        example: false
        description: Whether checks considered "unsafe" are assessed during a scan.
    description: ''
  ScanTemplateDatabase:
    type: object
    properties:
      db2:
        type: string
        example: database
        description: Database name for DB2 database instance.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      oracle:
        type: array
        example: default
        description: Database name (SID) for an Oracle database instance.
        items:
          type: string
      postgres:
        type: string
        example: postgres
        description: Database name for PostgesSQL database instance.
    description: ''
  CreatedReference«ScanTemplateID,Link»:
    type: object
    properties:
      id:
        type: string
        example: '1'
        description: The identifier of the resource created.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    description: ''
  Links:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    description: ''
  ScanTemplateVulnerabilityCheckCategories:
    type: object
    properties:
      disabled:
        type: array
        description: The categories of vulnerability checks to disable during a scan.
        items:
          type: string
      enabled:
        type: array
        description: The categories of vulnerability checks to enable during a scan.
        items:
          type: string
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
    description: ''
  ScanTemplateServiceDiscoveryTcp:
    type: object
    properties:
      additionalPorts:
        type: array
        example: 3078,8000-8080
        description: 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.
        items:
          type: object
      excludedPorts:
        type: array
        example: '1024'
        description: 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.
        items:
          type: object
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      method:
        type: string
        example: SYN
        description: The method of TCP discovery. Defaults to `SYN`.
        enum:
        - SYN
        - SYN+RST
        - SYN+FIN
        - SYN+ECE
        - Full
      ports:
        type: string
        example: well-known
        description: The TCP ports to scan. Defaults to `well-known`.
        enum:
        - all
        - well-known
        - custom
        - none
    description: ''
  UnauthorizedError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '401'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '401'
    description: ''
  ScanTemplateAssetDiscovery:
    type: object
    properties:
      collectWhoisInformation:
        type: boolean
        example: false
        description: Whether to query Whois during discovery. Defaults to `false`.
      fingerprintMinimumCertainty:
        type: number
        format: double
        example: 0.16
        description: The minimum certainty required for a fingerprint to be considered valid during a scan. Defaults to `0.16`.
        minimum: 0
        maximum: 1
      fingerprintRetries:
        type: integer
        format: int32
        example: 0
        description: The number of fingerprinting attempts made to determine the operating system fingerprint. Defaults to `4`.
        minimum: 0
        maximum: 1000
      ipFingerprintingEnabled:
        type: boolean
        example: true
        description: Whether to fingerprint TCP/IP stacks for hardware, operating system and software information.
      sendArpPings:
        type: boolean
        example: true
        description: Whether ARP pings are sent during asset discovery. Defaults to `true`.
      sendIcmpPings:
        type: boolean
        example: true
        description: Whether ICMP pings are sent during asset discovery. Defaults to `false`.
      tcpPorts:
        type: array
        description: TCP ports to send packets and perform discovery. Defaults to no ports.
        items:
          type: integer
          format: int32
      treatTcpResetAsAsset:
        type: boolean
        example: true
        description: Whether TCP reset responses are treated as live assets. Defaults to `true`.
      udpPorts:
        type: array
        description: UDP ports to send packets and perform discovery. Defaults to no ports.
        items:
          type: integer
          format: int32
    description: ''
  ScanTemplateDiscoveryPerformancePacketsRate:
    type: object
    properties:
      defeatRateLimit:
        type: boolean
        example: true
        description: 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:
        type: integer
        format: int32
        example: 15000
        description: The minimum number of packets to send each second during discovery attempts. Defaults to `0`.
        minimum: 0
        maximum: 15000
      minimum:
        type: integer
        format: int32
        example: 450
        description: The minimum number of packets to send each second during discovery attempts. Defaults to `0`.
        minimum: 0
        maximum: 15000
    description: ''
  ServiceUnavailableError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '503'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '503'
    description: ''
  ScanTemplateDiscoveryPerformance:
    type: object
    properties:
      packetRate:
        example: ''
        description: The number of packets to send per second during scanning.
        $ref: '#/definitions/ScanTemplateDiscoveryPerformancePacketsRate'
      parallelism:
        example: ''
        description: 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`.
        $ref: '#/definitions/ScanTemplateDiscoveryPerformanceParallelism'
      retryLimit:
        type: integer
        format: int32
        example: 3
        description: 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`.
        minimum: 1
        maximum: 15
      scanDelay:
        example: ''
        description: The duration to wait between sending packets to each target host during a scan.
        $ref: '#/definitions/ScanTemplateDiscoveryPerformanceScanDelay'
      timeout:
        example: ''
        description: The duration to wait between retry attempts.
        $ref: '#/definitions/ScanTemplateDiscoveryPerformanceTimeout'
    description: ''
  ScanTemplateWebSpiderPerformance:
    type: object
    properties:
      httpDaemonsToSkip:
        type: array
        description: The names of HTTP Daemons (HTTPd) to skip when spidering. For example, `"CUPS"`.
        items:
          type: string
      maximumDirectoryLevels:
        type: integer
        format: int32
        example: 6
        description: The directory depth limit for web spidering. Limiting directory depth can save significant time, especially with large sites. A value of `0` signifies unlimited directory traversal. Defaults to `6`.
        minimum: 1
        maximum: 100
      maximumForeignHosts:
        type: integer
        format: int32
        example: 100
        description: The maximum number of unique host names that the spider may resolve. This function adds substantial time to the spidering process, especially with large Web sites, because of frequent cross-link checking involved. Defaults to `100`.
      maximumLinkDepth:
        type: integer
        format: int32
        example: 6
        description: The maximum depth of links to traverse when spidering. Defaults to `6`.
        minimum: 0
        maximum: 100
      maximumPages:
        type: integer
        format: int32
        example: 3000
        description: The maximum the number of pages that are spidered. This is a time-saving measure for large sites. Defaults to `3000`.
        minimum: 0
        maximum: 1000000
      maximumRetries:
        type: integer
        format: int32
        example: 2
        description: The maximum the number of times to retry a request after a failure. A value of `0` means no retry attempts are made. Defaults to `2`.
        minimum: 0
        maximum: 999
      maximumTime:
        type: string
        example: PT0S
        description: The maximum length of time to web spider. This limit prevents scans from taking longer than the allotted scan schedule. A value of `PT0S` means no limit is applied. The acceptable range is `PT1M` to `PT16666.6667H`.
      responseTimeout:
        type: string
        example: PT2M
        description: The duration to wait for a response from a target web server. The value is specified as a ISO8601 duration and can range from `PT0S` (0ms) to `P1H` (1 hour). Defaults to `PT2M`.
      threadsPerServer:
        type: integer
        format: int32
        example: 3
        description: The number of threads to use per web server being spidered. Defaults to `3`.
        minimum: 0
        maximum: 999
    description: ''
  VulnerabilityCheckType:
    type: object
    properties:
      disabled:
        type: array
        description: The types of vulnerability checks to disable during a scan.
        items:
          type: string
      enabled:
        type: array
        description: The types of vulnerability checks to enable during a scan.
        items:
          type: string
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
    description: ''
  ScanTemplate:
    type: object
    properties:
      checks:
        example: ''
        description: "Settings for which vulnerability checks to run during a scan. <br/> \nThe rules for inclusion of checks is as follows: \n<ul> \n<li>Enabled checks by category and by check type are included</li> \n<li>Disabled checks in by category and by check type are removed</li> \n<li>Enabled checks in by individual check are added (even if they are disabled in by category or check type)</li> \n<li>Disabled checks in by individual check are removed</li> \n<li>If unsafe is disabled, unsafe checks are removed</li> \n<li>If potential is disabled, potential checks are removed</li> \n<ul>"
        $ref: '#/definitions/ScanTemplateVulnerabilityChecks'
      database:
        example: ''
        description: Settings for discovery databases.
        $ref: '#/definitions/ScanTemplateDatabase'
      description:
        type: string
        example: Performs a full network audit of all systems using only safe checks...
        description: A verbose description of the scan template..
      discovery:
        example: ''
        description: Discovery settings used during a scan.
        $ref: '#/definitions/ScanTemplateDiscovery'
      discoveryOnly:
        type: boolean
        example: false
        description: Whether only discovery is performed during a scan.
      enableWindowsServices:
        type: boolean
        example: false
        description: 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:
        type: boolean
        example: false
        description: Whether enhanced logging is gathered during scanning. Collection of enhanced logs may greatly increase the disk space used by a scan.
      id:
        type: string
        example: full-audit-without-web-spider
        description: The identifier of the scan template
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      maxParallelAssets:
        type: integer
        format: int32
        example: 10
        description: The maximum number of assets scanned simultaneously per scan engine during a scan.
      maxScanProcesses:
        type: integer
        format: int32
        example: 10
        description: The maximum number of scan processes simultaneously allowed against each asset during a scan.
      name:
        type: string
        example: Full audit
        description: A concise name for the scan template.
      policy:
        example: ''
        description: Policy configuration settings used during a scan.
        $ref: '#/definitions/Policy'
      policyEnabled:
        type: boolean
        example: true
        description: Whether policy assessment is performed during a scan.
      telnet:
        example: ''
        description: Settings for interacting with the Telnet protocol.
        $ref: '#/definitions/Telnet'
      vulnerabilityEnabled:
        type: boolean
        example: true
        description: Whether vulnerability assessment is performed during a scan.
      web:
        example: ''
        description: Web spider settings used during a scan.
        $ref: '#/definitions/ScanTemplateWebSpider'
      webEnabled:
        type: boolean
        example: true
        description: Whether web spidering and assessment are performed during a scan.
    description: ''
  ScanTemplateDiscoveryPerformanceScanDelay:
    type: object
    properties:
      maximum:
        type: string
        example: PT0S
        description: 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:
        type: string
        example: PT0S
        description: 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`.
    description: ''
  Telnet:
    type: object
    properties:
      characterSet:
        type: string
        example: ASCII
        description: The character set to use.
      failedLoginRegex:
        type: string
        example: (?:[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)
        description: Regular expression to match a failed login response.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      loginRegex:
        type: string
        example: '(?:[l,L]ogin|[u,U]ser.?[nN]ame) *\:'
        description: Regular expression to match a login response.
      passwordPromptRegex:
        type: string
        example: '(?:[p,P]assword|[p,P]asswd) *\:'
        description: Regular expression to match a password prompt.
      questionableLoginRegex:
        type: string
        example: (?:[l,L]ast [l,L]ogin *\:|allows only .* Telnet Client License)
        description: Regular expression to match a potential false negative login response.
    description: ''
  BadRequestError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '400'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '400'
    description: ''
  ScanTemplateServiceDiscovery:
    type: object
    properties:
      serviceNameFile:
        type: string
        example: ''
        description: 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:
        example: ''
        description: TCP service discovery settings.
        $ref: '#/definitions/ScanTemplateServiceDiscoveryTcp'
      udp:
        example: ''
        description: UDP service discovery settings.
        $ref: '#/definitions/ScanTemplateServiceDiscoveryUdp'
    description: ''
  Policy:
    type: object
    properties:
      enabled:
        type: array
        description: The identifiers of the policies enabled to be checked during a scan. No policies are enabled by default.
        items:
          type: integer
          format: int64
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      recursiveWindowsFSSearch:
        type: boolean
        example: false
        description: 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:
        type: boolean
        example: false
        description: 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`.
    description: ''
  ScanTemplateDiscovery:
    type: object
    properties:
      asset:
        example: ''
        description: Asset discovery settings used during a scan.
        $ref: '#/definitions/ScanTemplateAssetDiscovery'
      performance:
        example: ''
        description: Discovery performance settings used during a scan.
        $ref: '#/definitions/ScanTemplateDiscoveryPerformance'
      service:
        example: ''
        description: Service discovery settings used during a scan.
        $ref: '#/definitions/ScanTemplateServiceDiscovery'
    description: ''
  ScanTemplateWebSpiderPaths:
    type: object
    properties:
      boostrap:
        type: string
        example: /root
        description: Paths to bootstrap spidering with.
      excluded:
        type: string
        example: /root/sensitive.html
        description: Paths excluded from spidering.
      honorRobotDirectives:
        type: boolean
        example: false
        description: Whether to honor robot directives.
    description: ''
  Resources«ScanTemplate»:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      resources:
        type: array
        description: The resources returned.
        items:
          $ref: '#/definitions/ScanTemplate'
    description: ''
  ScanTemplateWebSpiderPatterns:
    type: object
    properties:
      sensitiveContent:
        type: string
        example: ''
        description: A regular expression that is used to find sensitive content on a page.
      sensitiveField:
        type: string
        example: (p|pass)(word|phrase|wd|code)
        description: A regular expression that is used to find fields that may contain sensitive input. Defaults to `"(p|pass)(word|phrase|wd|code)"`.
    description: ''
  ScanTemplateVulnerabilityCheckIndividual:
    type: object
    properties:
      disabled:
        type: array
        description: The individual vulnerability checks to disable during a scan.
        items:
          type: string
      enabled:
        type: array
        description: The individual vulnerability checks to enable during a scan.
        items:
          type: string
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
    description: ''
  ScanTemplateDiscoveryPerformanceTimeout:
    type: object
    properties:
      initial:
        type: string
        example: PT0.5S
        description: 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:
        type: string
        example: PT3S
        description: 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:
        type: string
        example: PT0S
        description: 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`.
    description: ''
  ScanTemplateServiceDiscoveryUdp:
    type: object
    properties:
      additionalPorts:
        type: array
        example: 4020-4032
        description: 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.
        items:
          type: object
      excludedPorts:
        type: array
        example: '9899'
        description: 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.
        items:
          type: object
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      ports:
        type: string
        example: well-known
        description: The UDP ports to scan. Defaults to `well-known`.
        enum:
        - all
        - well-known
        - custom
        - none
    description: ''
  Link:
    type: object
    properties:
      href:
        type: string
        example: https://hostname:3780/api/3/...
        description: 'A hypertext reference, which is either a URI (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>) or URI template (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc6570">RFC 6570</a>). '
      rel:
        type: string
        example: self
        description: The link relation type. This value is one from the <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5988#section-6.2">Link Relation Type Registry</a> or is the type of resource being linked to.
    description: ''
  ScanTemplateWebSpider:
    type: object
    properties:
      dontScanMultiUseDevices:
        type: boolean
        example: true
        description: Whether scanning of multi-use devices, such as printers or print servers should be avoided.
      includeQueryStrings:
        type: boolean
        example: false
        description: Whether query strings are using in URLs when web spidering. This causes the web spider to make many more requests to the Web server. This will increase overall scan time and possibly affect the Web server's performance for legitimate users.
      paths:
        example: ''
        description: Paths to use when web spidering.
        $ref: '#/definitions/ScanTemplateWebSpiderPaths'
      patterns:
        example: ''
        description: Patterns to match responses during web spidering.
        $ref: '#/definitions/ScanTemplateWebSpiderPatterns'
      performance:
        example: ''
        description: Performance settings used during web spidering.
        $ref: '#/definitions/ScanTemplateWebSpiderPerformance'
      testCommonUsernamesAndPasswords:
        type: boolean
        example: false
        description: Whether to determine if discovered logon forms accept commonly used user names or passwords. The process may cause authentication services with certain security policies to lock out accounts with these credentials.
      testXssInSingleScan:
        type: boolean
        example: false
        description: Whether to test for persistent cross-site scripting during a single scan. This test helps to reduce the risk of dangerous attacks via malicious code stored on Web servers. Enabling it may increase Web spider scan times.
      userAgent:
        type: string
        example: Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)
        description: The `User-Agent` to use when web spidering. Defaults to `"Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"`.
    description: ''