openapi: 3.1.0
info:
  title: InsightAppSec Accounts Site 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: Site
  description: Resources and operations for managing sites.
paths:
  /api/3/sites/{id}/assets:
    get:
      tags:
      - Site
      summary: Site Assets
      description: Retrieves a paged resource of assets linked with the specified site.
      operationId: getSiteAssets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: page
        in: query
        description: The index of the page (zero-based) to retrieve.
        required: false
        type: integer
        default: 0
        format: int32
      - name: size
        in: query
        description: The number of records per page to retrieve.
        required: false
        type: integer
        default: 10
        format: int32
      - name: sort
        in: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PageOf«Asset»'
          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:
      - Site
      summary: Site Assets
      description: Removes all assets from the specified site. Assets will be deleted entirely from the Security Console if either Asset Linking is disabled or if Asset Linking is enabled and the asset only existed in this site.
      operationId: removeSiteAssets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites:
    get:
      tags:
      - Site
      summary: Sites
      description: Retrieves a paged resource of accessible sites.
      operationId: getSites
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: page
        in: query
        description: The index of the page (zero-based) to retrieve.
        required: false
        type: integer
        default: 0
        format: int32
      - name: size
        in: query
        description: The number of records per page to retrieve.
        required: false
        type: integer
        default: 10
        format: int32
      - name: sort
        in: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PageOf«Site»'
          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:
      - Site
      summary: Sites
      description: Creates a new site with the specified configuration.
      operationId: createSite
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: site
        description: Resource for creating a site configuration.
        required: false
        schema:
          $ref: '#/definitions/SiteCreateResource'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«SiteID,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/sites/{id}:
    get:
      tags:
      - Site
      summary: Site
      description: Retrieves the site with the specified identifier.
      operationId: getSite
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Site'
          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:
      - Site
      summary: Site
      description: Updates the configuration of the site with the specified identifier.
      operationId: updateSite
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: site
        description: Resource for updating a site configuration.
        required: false
        schema:
          $ref: '#/definitions/SiteUpdateResource'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site
      description: Deletes the site with the specified identifier.
      operationId: deleteSite
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts:
    get:
      tags:
      - Site
      summary: Site Alerts
      description: Retrieve all alerts defined in the site.
      operationId: getSiteAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«Alert»'
          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:
      - Site
      summary: Site Alerts
      description: Deletes all alerts from the site.
      operationId: deleteAllSiteAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts/smtp:
    get:
      tags:
      - Site
      summary: Site SMTP Alerts
      description: Retrieves all SMTP alerts defined in the site.
      operationId: getSiteSmtpAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«SmtpAlert»'
          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:
      - Site
      summary: Site SMTP Alerts
      description: Creates a new SMTP alert for the specified site.
      operationId: createSiteSmtpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Resource for creating a new SMTP alert.
        required: false
        schema:
          $ref: '#/definitions/SmtpAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«AlertID,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: []
    put:
      tags:
      - Site
      summary: Site SMTP Alerts
      description: Updates all SMTP alerts for the specified site in a single request using the array of resources defined in the request body.
      operationId: setSiteSmtpAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Array of resources for updating all SMTP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/SmtpAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site SMTP Alerts
      description: Deletes all SMTP alerts from the site.
      operationId: deleteAllSiteSmtpAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts/smtp/{alertId}:
    get:
      tags:
      - Site
      summary: Site SMTP Alert
      description: Retrieves the specified SMTP alert.
      operationId: getSiteSmtpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SmtpAlert'
          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:
      - Site
      summary: Site SMTP Alert
      description: Updates the specified SMTP alert.
      operationId: updateSiteSmtpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Resource for updating the specified SMTP alert.
        required: false
        schema:
          $ref: '#/definitions/SmtpAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site SMTP Alert
      description: Deletes the specified SMTP alert from the site.
      operationId: deleteSiteSmtpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts/snmp:
    get:
      tags:
      - Site
      summary: Site SNMP Alerts
      description: Retrieves all SNMP alerts defined in the site.
      operationId: getSiteSnmpAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«SnmpAlert»'
          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:
      - Site
      summary: Site SNMP Alerts
      description: Creates a new SNMP alert for the specified site.
      operationId: createSiteSnmpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Resource for creating a new SNMP alert.
        required: false
        schema:
          $ref: '#/definitions/SnmpAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«AlertID,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: []
    put:
      tags:
      - Site
      summary: Site SNMP Alerts
      description: Updates all SNMP alerts for the specified site in a single request using the array of resources defined in the request body.
      operationId: setSiteSnmpAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Array of resources for updating all SNMP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/SnmpAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site SNMP Alerts
      description: Deletes all SNMP alerts from the site.
      operationId: deleteAllSiteSnmpAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts/snmp/{alertId}:
    get:
      tags:
      - Site
      summary: Site SNMP Alert
      description: Retrieves the specified SNMP alert.
      operationId: getSiteSnmpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SnmpAlert'
          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:
      - Site
      summary: Site SNMP Alert
      description: Updates the specified SNMP alert.
      operationId: updateSiteSnmpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Resource for updating the specified SNMP alert.
        required: false
        schema:
          $ref: '#/definitions/SnmpAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site SNMP Alert
      description: Deletes the specified SNMP alert from the site.
      operationId: deleteSiteSnmpAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts/syslog:
    get:
      tags:
      - Site
      summary: Site Syslog Alerts
      description: Retrieves all Syslog alerts defined in the site.
      operationId: getSiteSyslogAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«SyslogAlert»'
          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:
      - Site
      summary: Site Syslog Alerts
      description: Creates a new Syslog alert for the specified site.
      operationId: createSiteSyslogAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Resource for creating a new Syslog alert.
        required: false
        schema:
          $ref: '#/definitions/SyslogAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«AlertID,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: []
    put:
      tags:
      - Site
      summary: Site Syslog Alerts
      description: Updates all Syslog alerts for the specified site in a single request using the array of resources defined in the request body.
      operationId: setSiteSyslogAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Array of resources for updating all Syslog alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site.
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/SyslogAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Syslog Alerts
      description: Deletes all Syslog alerts from the site.
      operationId: deleteAllSiteSyslogAlerts
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/alerts/syslog/{alertId}:
    get:
      tags:
      - Site
      summary: Site Syslog Alert
      description: Retrieves the specified Syslog alert.
      operationId: getSiteSyslogAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SyslogAlert'
          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:
      - Site
      summary: Site Syslog Alert
      description: Updates the specified Syslog alert.
      operationId: updateSiteSyslogAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: alert
        description: Resource for updating the specified Syslog alert.
        required: false
        schema:
          $ref: '#/definitions/SyslogAlert'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Syslog Alert
      description: Deletes the specified Syslog alert from the site.
      operationId: deleteSiteSyslogAlert
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: alertId
        in: path
        description: The identifier of the alert.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/assets/{assetId}:
    delete:
      tags:
      - Site
      summary: Site Asset
      description: Removes an asset from a site. The asset will only be deleted if it belongs to no other sites.
      operationId: removeAssetFromSite
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: assetId
        in: path
        description: The identifier of the asset.
        required: true
        type: integer
        format: int64
      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: []
  /api/3/sites/{id}/discovery_connection:
    get:
      tags:
      - Site
      summary: Site Discovery Connection
      description: Retrieves the discovery connection assigned to the site.
      operationId: getSiteDiscoveryConnection
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SiteDiscoveryConnection'
          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:
      - Site
      summary: Site Discovery Connection
      description: Updates the discovery connection assigned to the site.
      operationId: setSiteDiscoveryConnection
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: connectionId
        description: The identifier of the discovery connection.
        required: false
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/discovery_search_criteria:
    get:
      tags:
      - Site
      summary: Site Discovery Search Criteria
      description: Retrieve the search criteria of the dynamic site.
      operationId: getSiteDiscoverySearchCriteria
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DiscoverySearchCriteria'
          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:
      - Site
      summary: Site Discovery Search Criteria
      description: Update the search criteria of the dynamic site.
      operationId: setSiteDiscoverySearchCriteria
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: param1
        description: param1
        required: true
        schema:
          $ref: '#/definitions/DiscoverySearchCriteria'
      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: []
  /api/3/sites/{id}/excluded_asset_groups:
    get:
      tags:
      - Site
      summary: Site Excluded Asset Groups
      description: Retrieves the excluded asset groups in a static site.
      operationId: getExcludedAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«AssetGroup»'
          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:
      - Site
      summary: Site Excluded Asset Groups
      description: Updates the excluded asset groups in a static site.
      operationId: updateExcludedAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: assetGroupIds
        description: Array of asset group identifiers.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Excluded Asset Groups
      description: Removes all excluded asset groups from the specified static site.
      operationId: removeAllExcludedAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/excluded_asset_groups/{assetGroupId}:
    delete:
      tags:
      - Site
      summary: Site Excluded Asset Group
      description: Removes the specified asset group from the excluded asset groups configured in the static site.
      operationId: removeExcludedAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: assetGroupId
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/excluded_targets:
    get:
      tags:
      - Site
      summary: Site Excluded Targets
      description: Retrieves the excluded targets in a static site.
      operationId: getExcludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ScanTargetsResource'
          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:
      - Site
      summary: Site Excluded Targets
      description: Adds one or more addresses to the site's list of excluded scan targets.
      operationId: addExcludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: scanTargetsToAdd
        description: List of addresses to add to the site's excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«SiteID,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: []
      x-code-samples:
      - lang: Add addresses to the site's excluded targets
        source: "[\n  \"machine1\",\n  \"machine2.acme.com\",\n  \"10.0.0.100\",\n  \"10.0.1.10-10.0.1.20\"\n]"
    put:
      tags:
      - Site
      summary: Site Excluded Targets
      description: Updates the excluded targets in a static site.
      operationId: updateExcludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanTargets
        description: List of addresses to be the site's new excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Excluded Targets
      description: Removes one or more addresses from the site's list of excluded scan targets.
      operationId: removeExcludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: scanTargetsToRemove
        description: List of address to remove from the sites excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        required: false
        schema:
          type: array
          items:
            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: []
      x-code-samples:
      - lang: Remove addresses from the site's excluded targets
        source: "[\n  \"machine1\",\n  \"machine2.acme.com\",\n  \"10.0.0.100\",\n  \"10.0.1.10-10.0.1.20\"\n]"
  /api/3/sites/{id}/included_asset_groups:
    get:
      tags:
      - Site
      summary: Site Included Asset Groups
      description: Retrieves the included asset groups in a static site.
      operationId: getIncludedAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«AssetGroup»'
          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:
      - Site
      summary: Site Included Asset Groups
      description: Updates the included asset groups in a static site.
      operationId: updateIncludedAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: assetGroupIds
        description: Array of asset group identifiers.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Included Asset Groups
      description: Removes all included asset groups from the specified static site.
      operationId: removeAllIncludedAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/included_asset_groups/{assetGroupId}:
    delete:
      tags:
      - Site
      summary: Site Included Asset Group
      description: Removes the specified asset group from the included asset groups configured in the static site.
      operationId: removeIncludedAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: assetGroupId
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/included_targets:
    get:
      tags:
      - Site
      summary: Site Included Targets
      description: Retrieves the included targets in a static site.
      operationId: getIncludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ScanTargetsResource'
          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:
      - Site
      summary: Site Included Targets
      description: Adds one or more addresses to the site's list of included scan targets.
      operationId: addIncludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: scanTargetsToAdd
        description: List of addresses to add to the site's included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«SiteID,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: []
      x-code-samples:
      - lang: Add addresses to the site's included targets
        source: "[\n  \"machine1\",\n  \"machine2.acme.com\",\n  \"10.0.0.100\",\n  \"10.0.1.10-10.0.1.20\"\n]"
    put:
      tags:
      - Site
      summary: Site Included Targets
      description: Updates the included targets in a static site.
      operationId: updateIncludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanTargets
        description: List of addresses to be the site's new included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Included Targets
      description: Removes one or more addresses from the site's list of included scan targets.
      operationId: removeIncludedTargets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: scanTargetsToRemove
        description: List of address to remove from the sites included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        required: false
        schema:
          type: array
          items:
            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: []
      x-code-samples:
      - lang: Remove addresses from the site's included targets
        source: "[\n  \"machine1\",\n  \"machine2.acme.com\",\n  \"10.0.0.100\",\n  \"10.0.1.10-10.0.1.20\"\n]"
  /api/3/sites/{id}/organization:
    get:
      tags:
      - Site
      summary: Site Organization Information
      description: Retrieves the site organization information.
      operationId: getSiteOrganization
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SiteOrganization'
          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:
      - Site
      summary: Site Organization Information
      description: Updates the site organization information.
      operationId: updateSiteOrganization
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: siteOrganization
        description: Resource for updating the specified site's organization information.
        required: false
        schema:
          $ref: '#/definitions/SiteOrganization'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/scan_engine:
    get:
      tags:
      - Site
      summary: Site Scan Engine
      description: Retrieves the resource of the scan engine assigned to the site.
      operationId: getSiteScanEngine
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ScanEngine'
          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:
      - Site
      summary: Site Scan Engine
      description: Updates the assigned scan engine to the site.
      operationId: setSiteScanEngine
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanEngineId
        description: The identifier of the scan engine.
        required: false
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/scan_schedules:
    get:
      tags:
      - Site
      summary: Site Scan Schedules
      description: Returns all scan schedules for the site.
      operationId: getSiteScanSchedules
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«ScanSchedule»'
          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:
      - Site
      summary: Site Scan Schedules
      description: Creates a new scan schedule for the specified site.
      operationId: createSiteScanSchedule
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanSchedule
        description: Resource for a scan schedule.
        required: false
        schema:
          $ref: '#/definitions/ScanSchedule'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«ScanScheduleID,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: []
    put:
      tags:
      - Site
      summary: Site Scan Schedules
      description: Updates all scan schedules for the specified site in a single request using the array of resources defined in the request body.
      operationId: setSiteScanSchedules
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanSchedules
        description: Array of resources for updating all scan schedules defined in the site. Scan schedules defined in the site that are omitted from this request will be deleted from the site.
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/ScanSchedule'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Scan Schedules
      description: Deletes all scan schedules from the site.
      operationId: deleteAllSiteScanSchedules
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/scan_schedules/{scheduleId}:
    get:
      tags:
      - Site
      summary: Site Scan Schedule
      description: Retrieves the specified scan schedule.
      operationId: getSiteScanSchedule
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: scheduleId
        in: path
        description: The identifier of the scan schedule.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ScanSchedule'
          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:
      - Site
      summary: Site Scan Schedule
      description: Updates the specified scan schedule.
      operationId: updateSiteScanSchedule
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanSchedule
        description: Resource for updating the specified scan schedule.
        required: false
        schema:
          $ref: '#/definitions/ScanSchedule'
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: scheduleId
        in: path
        description: The identifier of the scan schedule.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Scan Schedule
      description: Deletes the specified scan schedule from the site.
      operationId: deleteSiteScanSchedule
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: scheduleId
        in: path
        description: The identifier of the scan schedule.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/scan_template:
    get:
      tags:
      - Site
      summary: Site Scan Template
      description: Retrieves the resource of the scan template assigned to the site.
      operationId: getSiteScanTemplate
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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:
      - Site
      summary: Site Scan Template
      description: Updates the assigned scan template to the site.
      operationId: setSiteScanTemplate
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: scanTemplateId
        description: The identifier of the scan template.
        required: false
        schema:
          type: string
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/shared_credentials:
    get:
      tags:
      - Site
      summary: Assigned Shared Credentials
      description: Retrieve all of the shared credentials assigned to the site. These shared credentials can be enabled/disabled for the site's scan.
      operationId: getSiteSharedCredentials
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«SiteSharedCredential»'
          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: []
  /api/3/sites/{id}/shared_credentials/{credentialId}/enabled:
    put:
      tags:
      - Site
      summary: Assigned Shared Credential Enablement
      description: Enable or disable the shared credential for the site's scans.
      operationId: enableSharedCredentialOnSite
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: status
        description: Flag indicating whether the shared credential is enabled for the site's scans.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: credentialId
        in: path
        description: The identifier of the shared credential.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/site_credentials:
    get:
      tags:
      - Site
      summary: Site Scan Credentials
      description: Retrieves all defined site credential resources.
      operationId: getSiteCredentials
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«SiteCredential»'
          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:
      - Site
      summary: Site Scan Credentials
      description: Creates a new site credential.
      operationId: createSiteCredential
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: siteCredential
        description: The specification of a site credential.
        required: false
        schema:
          $ref: '#/definitions/SiteCredential'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/CreatedReference«CredentialID,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: []
      x-code-samples:
      - lang: A CIFS credential
        source: "{\n  \"name\": \"CIFS Administrator\",\n  \"description\": \"This is a cifs credential for an administrator. Credential is disabled for use in site scans and restricted to a single host for authentication.\",\n  \"enabled\": false,\n  \"account\": {\n    \"service\": \"cifs\",\n    \"username\": \"joe_smith@acme.com\",\n    \"password\": \"******\",\n    \"domain\": \"acme\"\n  },\n  \"hostRestriction\": \"machine1.acme.com\"\n}"
      - lang: A Microsoft SQL Server credential
        source: "{\n  \"name\": \"MS SQL Administrator\",\n  \"description\": \"This is an administrator credential for a Microsoft SQL Server database. Configured to use windows authentication. Credential is disabled for use in site scans.\",\n  \"enabled\": false,\n  \"account\": {\n    \"service\": \"ms-sql\",\n    \"database\": \"usersdb\",\n    \"useWindowsAuthentication\": true,\n    \"domain\": \"acme\",\n    \"username\": \"admin\",\n    \"password\": \"******\"\n  },\n  \"hostRestriction\": \"machine1.acme.com\"\n}\n"
      - lang: An Oracle database credential
        source: "{\n  \"name\": \"Oracle DB Administrator\",\n  \"description\": \"This is an administrator credential for an Oracle database. Credential is restricted to a single host and port for authentication.\",\n  \"enabled\": true,\n  \"account\": {\n    \"service\": \"oracle\",\n    \"sid\": \"usersdb\",\n    \"username\": \"admin\",\n    \"password\": \"******\",\n    \"enumerateSids\": true,\n    \"oracleListenerPassword\": \"******\"\n  },\n  \"hostRestriction\": \"192.168.1.1\",\n  \"portRestriction\": 1521\n}\n"
      - lang: An SNMPv3 credential
        source: "{\n  \"name\": \"SNMP v3 Administator\",\n  \"enabled\": true,\n  \"account\": {\n    \"service\": \"snmpv3\",\n    \"authenticationType\": \"md5\",\n    \"username\": \"admin\",\n    \"password\": \"******\",\n    \"privacyType\": \"aes-256\",\n    \"privacyPassword\": \"******\"\n  }\n}\n"
      - lang: An SSH credential
        source: "{\n  \"name\": \"SSH Administrator\",\n  \"description\": \"This is an SSH credential for an administrator. Credential is enabled for use in site scans.\",\n  \"enabled\": true,\n  \"account\": {\n    \"service\": \"ssh\",\n    \"username\": \"admin\",\n    \"password\": \"******\"\n  }\n}\n"
      - lang: An SSH credential using sudo+su permission elevation
        source: "{\n  \"name\": \"SSH User (permission elevation with sudo+su)\",\n  \"description\": \"This is an SSH credential for an non-administrative user. Credential is configured to perform permission elevation using sudo+su for additional access.\",\n  \"enabled\": true,\n  \"account\": {\n    \"service\": \"ssh\",\n    \"username\": \"jsmith\",\n    \"password\": \"******\",\n    \"permissionElevation\": \"sudosu\",\n    \"permissionElevationUsername\": \"root\",\n    \"permissionElevationPassword\": \"******\"\n  }\n}\n"
      - lang: An SSH public key credential
        source: "{\n  \"name\": \"SSH Public Key credential (permission elevation with sudo)\",\n  \"description\": \"This is an SSH credential for a non-administrative user using a PEM-format private key. Credential is also configured to elevate permissions using sudo.\",\n  \"enabled\": true,\n  \"account\": {\n    \"service\": \"ssh-key\",\n    \"username\": \"admin\",\n    \"privateKeyPassword\": \"*******\",\n    \"pemKey\": \"-----BEGIN RSA PRIVATE KEY-----\\nProc-Type: 4,ENCRYPTED\\nDEK-Info: AES-128-CBC,0D364155CB54D4B485BDB3B11B76BF59\\n\\nGLH7n9qeWzZ43g8d5ZNo9BcSWGXo7i8yd3ig9SLKXJd9GoxOrI4OepxZbhOJFDC9\\nXer799R8M4+ZGUwIC14R4lfzgKjcqEBCzya/c99MxK9Haz8pt5BjTMtUQRWO5y+/\\nyySosHRVebB05TuMhmLnJkNnDfTYwT+Hnvdhu/2ArEm2FN9Rr+guumwhQeGxUha5\\n7zjjSimLYjuU2uayjgFLfnh9g/Fe24qmHCw80z+nuHsm9WMWeoeOdmMrMmxhLxUb\\nb+zYZs/xRYjKgBMTRiXNSK9UIy21t2+7TUzeyDwfvHq0f5KpinhD1vzYSL+N0k/H\\ndg6vqM1gD/DLb+eKoAGpXTE0gpHWcXLg526ivlyZEpAxbuyGPVQ+7IIGytjxN7lG\\nJyvbk3fpKDwIJLDOFN4eb9DUaUoqyarqVl44BZhcs7mM0Cvn49IA7PfhcznLv4rJ\\netAoZ2Tjt0AiM774+4X29EaYBGXKGC3SYKfiznoEEy1Jpi6Akwxz4FKCEazH1wce\\nUaUS/N8VbquMPTqcLjCfoztdOgk65j4FczGt22CtGz4Ns8XB0KRM9fcVQFD4ZmRQ\\ni9Sr2onZUAMuvg3R6ZNdpm7FtQhNEpqV432TJdNZEMbXlDmG61P2vgILugKmu56r\\ngZfgI1QMUSUzZrnH+DXn0GY9KycRKTpY6L8PSUeTVyhDUFlTrTchvbnFf7LpVRRj\\n0+99EUxQFIogXt2rNuj6qioEpabh6rGtIPjICEkue75n2Y4Eu+pdPpSFAPNXLuMB\\nCcvoydmxWkBcq/wrCWcTKdKbGKXEj1xvHXAdUwcmlhXpn1igxcwRtcpwrN8cyRRB\\nddc1dDX6X/6iEnnWdDDWHZYjaMLUWVO0pPXzSEsZMFhS3wPvY1lg1Ertiag6DD0Q\\nwnJq19fJ5M8ehu9qMBdHgPIWdcZBMXSvaQqZ8gBtMO5UyuLA5BTP0yb6Jh3foXCq\\nCPihqYSCGUtXzupJCr/oE+jOaYNWjL5icEU0llA6lr71WWdj3b1OwrUTlrmgA0nK\\nxZu6LrqRT+nxbd4phYbkqmhXccq9H/d8pcZwKwPtF+z8HoZXSddaACYFAqY4eaxa\\nNRk2Zt1JJ+tUsNT9LLV1tUrQ+q1JsKlJp7LW60loljiex8uadsvzwnKIdoom8q0I\\nroXHdrwwqyubf4yYApRckbgzW9gLPbclKSqsVFGsDB+KysDYmg3QlTpkrgGl2555\\naQ7Z2TWWvcVL3y7z1l1F238m11LxKUY8Uvu7enpQ/gTrqQ1qqIi2/yv+LvZmAXWV\\nCFO2lMafpmmHjHEAI5ifXYzZlHCXYBHGHYJdGALFuhODiQqF4pOJI8CX/00msnlJ\\nbMH0+dGnk2AviiaLXb7eCZ7mELCX+Ah+00UU75Vdv7O3vhGHpjuMULvbLW2uo+cw\\n6rogJ4SfUBb0t+yS970Xty650DgpHYxCzDwZZzrQqPuX6SeOD8AnXuJL3cl3B5YU\\n60IPVJPsONIwvJlvZuiij4V8L95usGtvDVsexBKQlj3sSVZ5egICMBjkduEyDl3O\\nxOZtdnqktsWNF5XYUfa/8/HUYnN35g0UktpmKlg0yxhAxUAn4lENAY8xvhMGsSCO\\n-----END RSA PRIVATE KEY-----\",\n    \"permissionElevation\": \"sudo\",\n    \"permissionElevationUsername\": \"root\",\n    \"permissionElevationPassword\": \"*******\"\n  }\n}\n"
    put:
      tags:
      - Site
      summary: Site Scan Credentials
      description: Updates multiple site credentials.
      operationId: setSiteCredentials
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: siteCredentials
        description: A list of site credentials resources.
        required: false
        schema:
          type: array
          items:
            $ref: '#/definitions/SiteCredential'
      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:
      - Site
      summary: Site Scan Credentials
      description: Deletes all site credentials from the site.
      operationId: deleteAllSiteCredentials
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/site_credentials/{credentialId}:
    get:
      tags:
      - Site
      summary: Site Scan Credential
      description: Retrieves the specified site credential.
      operationId: getSiteCredential
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: credentialId
        in: path
        description: The identifier of the site credential.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SiteCredential'
          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:
      - Site
      summary: Site Scan Credential
      description: Updates the specified site credential.
      operationId: updateSiteCredential
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: credentialId
        in: path
        description: The identifier of the site credential.
        required: true
        type: integer
        format: int32
      - in: body
        name: siteCredential
        description: The specification of the site credential to update.
        required: false
        schema:
          $ref: '#/definitions/SiteCredential'
      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:
      - Site
      summary: Site Scan Credential
      description: Deletes the specified site credential.
      operationId: deleteSiteCredential
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: credentialId
        in: path
        description: The identifier of the site credential.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/site_credentials/{credentialId}/enabled:
    put:
      tags:
      - Site
      summary: Site Credential Enablement
      description: Enable or disable the site credential for scans.
      operationId: enableSiteCredential
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: status
        description: Flag indicating whether the credential is enabled for use during the scan.
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: credentialId
        in: path
        description: The identifier of the site credential.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/tags:
    get:
      tags:
      - Site
      summary: Site Tags
      description: Retrieves the list of tags added to the sites.
      operationId: getSiteTags
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«Tag»'
          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:
      - Site
      summary: Site Tags
      description: Updates the site's list of tags.
      operationId: setSiteTags
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - in: body
        name: tags
        description: A list of tag identifiers to replace the site's tags.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      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: []
  /api/3/sites/{id}/tags/{tagId}:
    put:
      tags:
      - Site
      summary: Site Tag
      description: Adds a tag to the site.
      operationId: addSiteTag
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: tagId
        in: path
        description: The identifier of the tag.
        required: true
        type: integer
        format: int32
      responses:
        '201':
          description: Created
          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:
      - Site
      summary: Site Tag
      description: Removes the specified tag from the site's tags.
      operationId: removeSiteTag
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: tagId
        in: path
        description: The identifier of the tag.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/users:
    get:
      tags:
      - Site
      summary: Site Users Access
      description: Retrieve the list of non-administrator users that have access to the site.
      operationId: getSiteUsers
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«User»'
          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:
      - Site
      summary: Site Users Access
      description: Grants a non-administrator user access to the specified site.
      operationId: addSiteUser
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: param0
        description: The identifier of the user.
        required: false
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ReferenceWith«UserID,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: []
    put:
      tags:
      - Site
      summary: Site Users Access
      description: Updates the site's access list.
      operationId: setSiteUsers
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: users
        description: A list of user identifiers to replace the site's access list.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/users/{userId}:
    delete:
      tags:
      - Site
      summary: Site User Access
      description: Removes the specified user from the site's access list.
      operationId: removeSiteUser
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      - name: userId
        in: path
        description: The identifier of the user.
        required: true
        type: integer
        format: int32
      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: []
  /api/3/sites/{id}/web_authentication/html_forms:
    get:
      tags:
      - Site
      summary: Web Authentication HTML Forms
      description: Retrieves all HTML form authentications configured in the site.
      operationId: getWebAuthHtmlForms
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«WebFormAuthentication»'
          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: []
  /api/3/sites/{id}/web_authentication/http_headers:
    get:
      tags:
      - Site
      summary: Web Authentication HTTP Headers
      description: Retrieves all HTTP header authentications configured in the site.
      operationId: getWebAuthHTTPHeaders
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the site.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Resources«WebHeaderAuthentication»'
          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:
  File:
    type: object
    required:
    - name
    - type
    properties:
      attributes:
        type: array
        description: Attributes detected on the file.
        items:
          $ref: '#/definitions/Configuration'
      name:
        type: string
        example: ADMIN$
        description: The name of the file.
      size:
        type: integer
        format: int64
        example: -1
        description: The size of the regular file (in bytes). If the file is a directory, no value is returned.
      type:
        type: string
        example: directory
        description: The type of the file.
        enum:
        - file
        - directory
    description: ''
  ScanEngine:
    type: object
    required:
    - address
    - id
    - name
    - port
    properties:
      address:
        type: string
        example: corporate-scan-engine-001.acme.com
        description: The address the scan engine is hosted.
      contentVersion:
        type: string
        example: ''
        description: The content version of the scan engine.
        readOnly: true
      enginePools:
        type: array
        description: A list of identifiers of engine pools this engine is included in.
        readOnly: true
        items:
          type: integer
          format: int32
      id:
        type: integer
        format: int32
        example: 6
        description: The identifier of the scan engine.
      lastRefreshedDate:
        type: string
        example: ''
        description: The date the engine was last refreshed. Date format is in ISO 8601.
        readOnly: true
      lastUpdatedDate:
        type: string
        example: ''
        description: The date the engine was last updated. Date format is in ISO 8601.
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: Corporate Scan Engine 001
        description: The name of the scan engine.
      port:
        type: integer
        format: int32
        example: 40894
        description: The port used by the scan engine to communicate with the Security Console.
      productVersion:
        type: string
        example: ''
        description: The product version of the scan engine.
        readOnly: true
      sites:
        type: array
        description: A list of identifiers of each site the scan engine is assigned to.
        items:
          type: integer
          format: int32
      status:
        type: string
        example: ''
        description: "The scan engine status. Can be one of the following values: \n| Value                     | Description                                                                                | \n| ------------------------- | ------------------------------------------------------------------------------------------ | \n| `\"active\"`                | The scan engine is active.                                                                 | \n| `\"incompatible-version\"`  | The product version of the remote scan engine is not compatible with the Security Console. | \n| `\"not-responding\"`        | The scan engine is not responding to the Security Console.                                 | \n| `\"pending-authorization\"` | The Security Console is not yet authorized to connect to the scan engine.                  | \n| `\"unknown\"`               | The status of the scan engine is unknown.                                                  | \n"
        readOnly: true
        enum:
        - active
        - incompatible-version
        - not-responding
        - pending-authorization
        - unknown
    description: ''
  Resources«SiteCredential»:
    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/SiteCredential'
    description: ''
  AssetHistory:
    type: object
    properties:
      date:
        type: string
        example: '2018-04-09T06:23:49Z'
        description: The date the asset information was collected or changed.
      description:
        type: string
        example: ''
        description: Additional information describing the change.
      scanId:
        type: integer
        format: int64
        example: 12
        description: If a scan-oriented change, the identifier of the corresponding scan the asset was scanned in.
      type:
        type: string
        example: SCAN
        description: "The type of change. May be one of: \n| Type                                | Source of Data                                              | \n| ----------------------------------- | ----------------------------------------------------------- | \n| `ASSET-IMPORT`, `EXTERNAL-IMPORT`   | External source such as the API                             | \n| `EXTERNAL-IMPORT-APPSPIDER`         | Rapid7 InsightAppSec (previously known as AppSpider)        | \n| `SCAN`                              | Scan engine scan                                            | \n| `AGENT-IMPORT`                      | Rapid7 Insight Agent                                        | \n| `ACTIVE-SYNC`                       | ActiveSync                                                  | \n| `SCAN-LOG-IMPORT`                   | Manual import of a scan log                                 | \n| `VULNERABILITY_EXCEPTION_APPLIED`   | Vulnerability exception applied                             | \n| `VULNERABILITY_EXCEPTION_UNAPPLIED` | Vulnerability exception unapplied                           |"
      user:
        type: string
        example: ''
        description: If a vulnerability exception change, the login name of the user that performed the operation.
      version:
        type: integer
        format: int32
        example: 8
        description: 'The version number of the change (a chronological incrementing number starting from 1). '
      vulnerabilityExceptionId:
        type: integer
        format: int32
        example: ''
        description: If a vulnerability exception change, the identifier of the vulnerability exception that caused the change.
    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: ''
  ReferenceWith«ScanScheduleID,Link»:
    type: object
    properties:
      id:
        type: integer
        format: int32
        example: <id>
        description: The identifier of the resource.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    description: ''
  Database:
    type: object
    required:
    - name
    properties:
      description:
        type: string
        example: Microsoft SQL Server
        description: The description of the database instance.
      id:
        type: integer
        format: int32
        example: 13
        description: The identifier of the database.
      name:
        type: string
        example: MSSQL
        description: The name of the database instance.
    description: ''
  Resources«User»:
    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/User'
    description: ''
  WebApplication:
    type: object
    properties:
      id:
        type: integer
        format: int64
        example: 30712
        description: The identifier of the web application.
      pages:
        type: array
        description: The pages discovered on the web application.
        items:
          $ref: '#/definitions/WebPage'
      root:
        type: string
        example: /
        description: The web root of the web application.
      virtualHost:
        type: string
        example: 102.89.22.253
        description: The virtual host of the web application.
    description: ''
  SiteSharedCredential:
    type: object
    properties:
      enabled:
        type: boolean
        example: false
        description: Flag indicating whether the shared credential is enabled for the site's scans.
        readOnly: true
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the shared credential.
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The name of the shared credential.
        readOnly: true
      service:
        type: string
        example: ''
        description: The type of service the credential is configured to authenticate with.
        readOnly: true
        enum:
        - as400
        - cifs
        - cifshash
        - cvs
        - db2
        - ftp
        - http
        - ms-sql
        - mysql
        - notes
        - oracle
        - pop
        - postgresql
        - remote-exec
        - snmp
        - snmpv3
        - ssh
        - ssh-key
        - sybase
        - telnet
        - kerberos
        - hana
    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: ''
  ScanTargetsResource:
    type: object
    properties:
      addresses:
        type: array
        description: List of addresses. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        items:
          type: string
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
    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: ''
  SiteCreateResource:
    type: object
    required:
    - name
    properties:
      description:
        type: string
        example: ''
        description: The site's description.
      engineId:
        type: integer
        format: int32
        example: ''
        description: The identifier of a scan engine. Default scan engine is selected when not specified.
      importance:
        type: string
        example: ''
        description: The site importance. Defaults to `"normal"` if not specified.
        enum:
        - very_low
        - low
        - normal
        - high
        - very_high
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The site name. Name must be unique.
      scan:
        example: ''
        description: Defines the scope of scan targets for the site, which can be addresses, or asset groups, for static sites and a discovery configuration for dynamic sites. Only one property must be set by the user when saving a site.
        $ref: '#/definitions/ScanScope'
      scanTemplateId:
        type: string
        example: ''
        description: The identifier of a scan template. Default scan template is selected when not specified.
    description: ''
  ScanEvents:
    type: object
    required:
    - failed
    - paused
    - started
    - stopped
    properties:
      failed:
        type: boolean
        example: false
        description: Generates an alert when a scan fails. Default value is `false`.
      paused:
        type: boolean
        example: false
        description: Generates an alert when a scan pauses. Default value is `false`.
      resumed:
        type: boolean
        example: false
        description: Generates an alert when a scan resumes. Default value is `false`.
      started:
        type: boolean
        example: false
        description: Generates an alert when a scan starts. Default value is `false`.
      stopped:
        type: boolean
        example: false
        description: Generates an alert when a scan stops. Default value is `false`.
    description: ''
  IncludedScanTargets:
    type: object
    properties:
      addresses:
        type: array
        description: List of addresses. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        items:
          type: string
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
    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: ''
  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: ''
  PageInfo:
    type: object
    properties:
      number:
        type: integer
        format: int64
        example: 6
        description: The index (zero-based) of the current page returned.
      size:
        type: integer
        format: int64
        example: 10
        description: The maximum size of the page returned.
      totalPages:
        type: integer
        format: int64
        example: 13
        description: The total number of pages available.
      totalResources:
        type: integer
        format: int64
        example: 123
        description: The total number of resources available across all pages.
    description: ''
  AuthenticationSource:
    type: object
    properties:
      external:
        type: boolean
        example: false
        description: Whether the authentication source is external (true) or internal (false).
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the authentication source.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The name of the authentication source.
      type:
        type: string
        example: ''
        description: The type of the authentication source.
        enum:
        - normal
        - kerberos
        - ldap
        - saml
        - admin
    description: ''
  Configuration:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        example: <name>
        description: The name of the configuration value.
      value:
        type: string
        example: <value>
        description: The configuration value.
    description: ''
  UniqueId:
    type: object
    required:
    - id
    properties:
      id:
        type: string
        example: c56b2c59-4e9b-4b89-85e2-13f8146eb071
        description: The unique identifier.
      source:
        type: string
        example: WQL
        description: The source of the unique identifier.
    description: ''
  Resources«Tag»:
    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/Tag'
    description: ''
  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: ''
  SwaggerSearchCriteriaFilter:
    type: object
    properties:
      field:
        type: string
        example: ''
        description: The filter field for the search criteria.
      lower:
        type: object
        example: ''
        description: The lower value to match in a range criteria.
      operator:
        type: string
        example: ''
        description: The operator on how to match the search criteria.
      upper:
        type: object
        example: ''
        description: The upper value to match in a range criteria.
      value:
        type: object
        example: ''
        description: The single value to match using the operator.
      values:
        type: array
        description: An array of values to match using the operator.
        items:
          type: object
    description: ''
  Account:
    type: object
    properties:
      service:
        type: string
    description: ''
  UserRole:
    type: object
    properties:
      allAssetGroups:
        type: boolean
        example: false
        description: Whether the user has access to all asset groups.
      allSites:
        type: boolean
        example: false
        description: Whether the user has access to all sites.
      id:
        type: string
        example: ''
        description: The identifier of the role the user is assigned to.
      name:
        type: string
        example: ''
        description: The name of the role the user is assigned to.
      privileges:
        type: array
        description: The privileges granted to the user by their role.
        items:
          type: string
          enum:
          - all-permissions
          - create-reports
          - configure-global-settings
          - manage-sites
          - manage-tags
          - manage-static-asset-groups
          - manage-dynamic-asset-groups
          - manage-scan-templates
          - manage-report-templates
          - manage-scan-engines
          - submit-vulnerability-exceptions
          - approve-vulnerability-exceptions
          - delete-vulnerability-exceptions
          - manage-vuln-investigations
          - view-vuln-investigations
          - create-tickets
          - close-tickets
          - assign-ticket-assignee
          - manage-site-access
          - manage-asset-group-access
          - manage-report-access
          - use-restricted-report-sections
          - manage-policies
          - view-asset-group-asset-data
          - manage-asset-group-assets
          - view-site-asset-data
          - specify-site-metadata
          - purge-site-asset-data
          - specify-scan-targets
          - assign-scan-engine
          - assign-scan-template
          - manage-site-credentials
          - manage-scan-alerts
          - schedule-automatic-scans
          - start-unscheduled-scans
      superuser:
        type: boolean
        example: false
        description: Whether the user is a superuser.
    description: ''
  Resources«ScanSchedule»:
    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/ScanSchedule'
    description: ''
  PageOf«Asset»:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      page:
        example: ''
        description: The details of pagination indicating which page was returned, and how the remaining pages can be retrieved.
        $ref: '#/definitions/PageInfo'
      resources:
        type: array
        description: The page of resources returned.
        items:
          $ref: '#/definitions/Asset'
    description: ''
  Resources«SnmpAlert»:
    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/SnmpAlert'
    description: ''
  SiteUpdateResource:
    type: object
    required:
    - engineId
    - importance
    - name
    - scanTemplateId
    properties:
      description:
        type: string
        example: ''
        description: The site's description.
      engineId:
        type: integer
        format: int32
        example: ''
        description: The identifier of a scan engine.
      importance:
        type: string
        example: ''
        description: The site importance.
        enum:
        - very_low
        - low
        - normal
        - high
        - very_high
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The site name. Name must be unique.
      scanTemplateId:
        type: string
        example: ''
        description: The identifier of a scan template.
    description: ''
  Site:
    type: object
    properties:
      assets:
        type: integer
        format: int32
        example: 768
        description: The number of assets that belong to the site.
        readOnly: true
      connectionType:
        type: string
        example: ''
        description: The type of discovery connection configured for the site. This property only applies to dynamic sites.
        readOnly: true
        enum:
        - activesync-ldap
        - activesync-office365
        - activesync-powershell
        - aws
        - dhcp
        - sonar
        - vsphere
      description:
        type: string
        example: ''
        description: The site description.
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the site.
      importance:
        type: string
        example: ''
        description: The site importance.
      lastScanTime:
        type: string
        example: ''
        description: The date and time of the site's last scan.
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The site name.
      riskScore:
        type: number
        format: double
        example: 4457823.78
        description: The risk score (with criticality adjustments) of the site.
        readOnly: true
      scanEngine:
        type: integer
        format: int32
        example: ''
        description: The identifier of the scan engine configured in the site.
      scanTemplate:
        type: string
        example: ''
        description: The identifier of the scan template configured in the site.
      type:
        type: string
        example: ''
        description: The type of the site.
        readOnly: true
        enum:
        - agent
        - dynamic
        - static
      vulnerabilities:
        example: ''
        description: Summary information for distinct vulnerabilities found on the assets.
        readOnly: true
        $ref: '#/definitions/Vulnerabilities'
    description: ''
  Links:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    description: ''
  HostName:
    type: object
    required:
    - name
    properties:
      name:
        type: string
        example: corporate-workstation-1102DC.acme.com
        description: The host name (local or FQDN).
      source:
        type: string
        example: DNS
        description: The source used to detect the host name. `user` indicates the host name source is user-supplied (e.g. in a site target definition).
        enum:
        - user
        - dns
        - netbios
        - dce
        - epsec
        - ldap
        - other
    description: ''
  Resources«WebFormAuthentication»:
    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/WebFormAuthentication'
    description: ''
  CreatedReference«CredentialID,Link»:
    type: object
    properties:
      id:
        type: integer
        format: int32
        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: ''
  Repeat:
    type: object
    required:
    - every
    - interval
    properties:
      dayOfWeek:
        type: string
        example: ''
        description: The day of the week the scheduled task should repeat. This property only applies to schedules with a `every` value of `"day-of-month"`.
      every:
        type: string
        example: date-of-month
        description: "The frequency schedule repeats. Each value represents a different unit of time and is used in conjunction with the property `interval`. For example, a schedule can repeat hourly, daily, monthly, etc. The following table describes each supported value: \n| Value | Description | \n| ---------- | ---------------- | \n| hour | Specifies the schedule repeats in hourly increments. | \n| day | Specifies the schedule repeats in daily increments. | \n| week | Specifies the schedule repeats in weekly increments. | \n| date-of-month | Specifies the schedule repeats nth day of the `interval` month. Requires the property `dateOfMonth` to be specified. For example, if `dateOfMonth` is `17` and the `interval` is `2`, then the schedule will repeat every 2 months on the 17th day of the month. | \n| day-of-month | Specifies the schedule repeats on a monthly interval but instead of a specific date being specified, the day of the week and week of the month are specified. Requires the properties `dayOfWeek` and `weekOfMonth` to be specified. For example, if `dayOfWeek` is `\"friday\"`, `weekOfMonth` is `3`, and the `interval` is `4`, then the schedule will repeat every 4 months on the 3rd Friday of the month. | \n"
      interval:
        type: integer
        format: int32
        example: 1
        description: The interval time the schedule should repeat. The is depends on the value set in `every`. For example, if the value in property `every` is set to `"day"` and `interval` is set to `2`, then the schedule will repeat every 2 days.
        minimum: 1
      lastDayOfMonth:
        type: boolean
        example: false
        description: Whether to run the scheduled task on the last day of the month.
      weekOfMonth:
        type: integer
        format: int32
        example: ''
        description: The week of the month the scheduled task should repeat. For This property only applies to schedules with a `every` value of `"day-of-month"`. Each week of the month is counted in 7-day increments. For example, week 1 consists of days 1-7 of the month while week 2 consists of days 8-14 of the month and so forth.
        minimum: 1
        maximum: 6
    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: ''
  SnmpAlert:
    type: object
    required:
    - community
    - enabled
    - name
    - notification
    - server
    properties:
      community:
        type: string
        example: ''
        description: The SNMP community name.
      enabled:
        type: boolean
        example: false
        description: Flag indicating the alert is enabled.
      enabledScanEvents:
        example: ''
        description: Allows the user to specify which scan events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledScanEvents`.
        $ref: '#/definitions/ScanEvents'
      enabledVulnerabilityEvents:
        example: ''
        description: Allows the user to specify which vulnerability result events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledVulnerabilityEvents`.
        $ref: '#/definitions/VulnerabilityEvents'
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the alert.
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      maximumAlerts:
        type: integer
        format: int32
        example: ''
        description: The maximum number of alerts that will be issued. To disable maximum alerts, omit the property in the request or specify the property with a value of `null`.
        minimum: 1
      name:
        type: string
        example: ''
        description: The name of the alert.
      notification:
        type: string
        example: ''
        description: The type of alert.
        enum:
        - SMTP
        - SNMP
        - Syslog
      server:
        type: string
        example: ''
        description: The SNMP management server.
    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: ''
  IncludedAssetGroups:
    type: object
    properties:
      assetGroupIDs:
        type: array
        description: List of asset group identifiers. Each element is an integer.
        items:
          type: integer
          format: int32
      links:
        type: array
        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: ''
  Alert:
    type: object
    required:
    - enabled
    - name
    - notification
    properties:
      enabled:
        type: boolean
        example: false
        description: Flag indicating the alert is enabled.
      enabledScanEvents:
        example: ''
        description: Allows the user to specify which scan events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledScanEvents`.
        $ref: '#/definitions/ScanEvents'
      enabledVulnerabilityEvents:
        example: ''
        description: Allows the user to specify which vulnerability result events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledVulnerabilityEvents`.
        $ref: '#/definitions/VulnerabilityEvents'
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the alert.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      maximumAlerts:
        type: integer
        format: int32
        example: ''
        description: The maximum number of alerts that will be issued. To disable maximum alerts, omit the property in the request or specify the property with a value of `null`.
        minimum: 1
      name:
        type: string
        example: ''
        description: The name of the alert.
      notification:
        type: string
        example: ''
        description: The type of alert.
        enum:
        - SMTP
        - SNMP
        - Syslog
    description: ''
  AssetGroup:
    type: object
    required:
    - name
    - type
    properties:
      assets:
        type: integer
        format: int32
        example: 768
        description: The number of assets that belong to the asset group.
        readOnly: true
      description:
        type: string
        example: Assets with unacceptable high risk required immediate remediation.
        description: The description of the asset group.
      id:
        type: integer
        format: int32
        example: 61
        description: The identifier of the asset group.
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: High Risk Assets
        description: The name of the asset group.
      riskScore:
        type: number
        format: double
        example: 4457823.78
        description: The total risk score of all assets that belong to the asset group.
        readOnly: true
      searchCriteria:
        example: ''
        description: 'Search criteria used to determine dynamic membership, if `type` is `"dynamic"`. '
        $ref: '#/definitions/SearchCriteria'
      type:
        type: string
        example: dynamic
        description: The type of the asset group.
        enum:
        - static
        - dynamic
      vulnerabilities:
        example: ''
        description: Summary information for distinct vulnerabilities found on the assets.
        readOnly: true
        $ref: '#/definitions/Vulnerabilities'
    description: ''
  SiteOrganization:
    type: object
    properties:
      address:
        type: string
        example: ''
        description: The address.
      city:
        type: string
        example: ''
        description: The city.
      contact:
        type: string
        example: ''
        description: The contact person name.
      country:
        type: string
        example: ''
        description: The country.
      email:
        type: string
        example: ''
        description: The e-mail address.
      jobTitle:
        type: string
        example: ''
        description: The job title.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The organization name.
      phone:
        type: string
        example: ''
        description: The phone number.
      state:
        type: string
        example: ''
        description: The state.
      url:
        type: string
        example: ''
        description: The organization URL.
      zipCode:
        type: string
        example: ''
        description: The zip or region code.
    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: ''
  SiteCredential:
    type: object
    required:
    - account
    - name
    properties:
      account:
        example: ''
        description: "Specify the type of service to authenticate as well as all of the information required by that service. <div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">service</span> <span class=\"param-type\">string</span> \n<div class=\"param-enum\"> \n<span class=\"param-enum-value string\">\"as400\"</span> \n<span class=\"param-enum-value string\">\"cifs\"</span> \n<span class=\"param-enum-value string\">\"cifshash\"</span> \n<span class=\"param-enum-value string\">\"cvs\"</span> \n<span class=\"param-enum-value string\">\"db2\"</span> \n<span class=\"param-enum-value string\">\"ftp\"</span> \n<span class=\"param-enum-value string\">\"http\"</span> \n<span class=\"param-enum-value string\">\"ms-sql\"</span> \n<span class=\"param-enum-value string\">\"mysql\"</span> \n<span class=\"param-enum-value string\">\"notes\"</span> \n<span class=\"param-enum-value string\">\"oracle\"</span> \n<span class=\"param-enum-value string\">\"pop\"</span> \n<span class=\"param-enum-value string\">\"postgresql\"</span> \n<span class=\"param-enum-value string\">\"remote-exec\"</span> \n<span class=\"param-enum-value string\">\"snmp\"</span> \n<span class=\"param-enum-value string\">\"snmpv3\"</span> \n<span class=\"param-enum-value string\">\"ssh\"</span> \n<span class=\"param-enum-value string\">\"ssh-key\"</span> \n<span class=\"param-enum-value string\">\"sybase\"</span> \n<span class=\"param-enum-value string\">\"telnet\"</span> \n</div> \n<div class=\"redoc-markdown-block\">The type of service to authenticate with.</div>\n</div> \n</div>\n\nThe following are the names of the valid values for service: \n| Value         | Service                                         | \n| ------------- | ----------------------------------------------- | \n| `as400`       | IBM AS/400                                      | \n| `cifs`        | Microsoft Windows/Samba (SMB/CIFS)              | \n| `cifshash`    | Microsoft Windows/Samba LM/NTLM Hash (SMB/CIFS) | \n| `cvs`         | Concurrent Versioning System (CVS)              | \n| `db2`         | DB2                                             | \n| `ftp`         | File Transfer Protocol (FTP)                    | \n| `http`        | Web Site HTTP Authentication                    | \n| `ms-sql`      | Microsoft SQL Server                            | \n| `mysql`       | MySQL Server                                    | \n| `notes`       | Lotus Notes/Domino                              | \n| `oracle`      | Oracle                                          | \n| `pop`         | Post Office Protocol (POP)                      | \n| `postgresql`  | PostgreSQL                                      | \n| `remote-exec` | Remote Execution                                | \n| `snmp`        | Simple Network Management Protocol v1/v2c       | \n| `snmpv3`      | Simple Network Management Protocol v3           | \n| `ssh`         | Secure Shell (SSH)                              | \n| `ssh-key`     | Secure Shell (SSH) Public Key                   | \n| `sybase`      | Sybase SQL Server                               | \n| `telnet`      | Telnet                                          | \n\n<p>The following is a specification of supported credential properties for each type of service. These properties are to be specified within the <code>account</code> object.</p>\n\n`as400` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">domain</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The address of the domain.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`cifs` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">domain</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The address of the domain.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`cifshash` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">domain</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The address of the domain.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">ntlmHash</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The NTLM password hash. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`cvs` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">domain</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The address of the domain.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`db2` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">database</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The name of the database.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`ftp` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`http` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">realm</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The realm.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`ms-sql` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">database</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The name of the database. If not specified, a default database name will be used during authentication.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">useWindowsAuthentication</span> <span class=\"param-type\">boolean</span> \n<div class=\"redoc-markdown-block\">\n<p>\nBoolean flag signaling whether to connect to the database using Windows authentication. When set to <code>true</code>, Windows authentication is attempted; when set to <code>false</code>, SQL authentication is attempted.</p>\n</div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">domain</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The address of the domain. This property cannot be specified unless property <code>useWindowsAuthentication</code> is set to <code>true</code>.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`mysql` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">database</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The name of the database. If not specified, a default database name will be used during authentication.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The Notes ID password. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`notes` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">notesIDPassword</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`oracle` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">sid</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The name of the database. If not specified, a default database name will be used during authentication.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">enumerateSids</span> <span class=\"param-type\">boolean</span> \n<div class=\"redoc-markdown-block\">\n<p>\nBoolean flag instructing the scan engine to attempt to enumerate SIDs from your environment. If set to <code>true</code>, set the Oracle Net Listener password in property <code>oracleListenerPassword</code>.</p>\n</div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">oracleListenerPassword</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The Oracle Net Listener password. Used to enumerate SIDs from your environment.</p></div>\n</div> \n</div>\n\n`pop` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`postgresql` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">database</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The name of the database.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`remote-exec` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`snmp` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">communityName</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The community name that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`snmpv3` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">authenticationType</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"param-enum\"> \n<span class=\"param-enum-value string\">\"no-authentication\"</span> \n<span class=\"param-enum-value string\">\"md5\"</span> \n<span class=\"param-enum-value string\">\"sha\"</span> \n</div> \n<div class=\"redoc-markdown-block\"><p>The authentication protocols available to use in SNMP v3.</p></div>\n</div>\n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\">\n<p>\nThe password for the account that will be used for authenticating. Is required when the property <code>authenticationType</code> is set to valid value other than <code>\"no-authentication\"</code>. <strong>Note: This property is not returned in responses for security.</strong></p>\n</div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">privacyType</span> <span class=\"param-type\">string</span> \n<div class=\"param-enum\"> \n<span class=\"param-enum-value string\">\"no-privacy\"</span> \n<span class=\"param-enum-value string\">\"des\"</span> \n<span class=\"param-enum-value string\">\"aes-128\"</span> \n<span class=\"param-enum-value string\">\"aes-192\"</span> \n<span class=\"param-enum-value string\">\"aes-192-with-3-des-key-extension\"</span> \n<span class=\"param-enum-value string\">\"aes-256\"</span> \n<span class=\"param-enum-value string\">\"aes-265-with-3-des-key-extension\"</span> \n</div> \n<div class=\"redoc-markdown-block\"><p>The privacy protocols available to use in SNMP v3.</p></div>\n</div>\n<div class=\"property-info\"> \n<span class=\"property-name\">privacyPassword</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\">\n<p>\nThe privacy password for the account that will be used for authenticating. Is required when the property <code>authenticationType</code> is set to valid value other than <code>\"no-authentication\"</code> and when the <code>privacyType</code> is set to a valid value other than code>\"no-privacy\"</code>. <strong>Note: This property is not returned in responses for security.</strong></p>\n</div>\n</div> \n</div>\n\n`ssh` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">permissionElevation</span> <span class=\"param-type\">string</span> \n<div class=\"param-enum\"> \n<span class=\"param-enum-value string\">\"none\"</span> \n<span class=\"param-enum-value string\">\"sudo\"</span> \n<span class=\"param-enum-value string\">\"sudosu\"</span> \n<span class=\"param-enum-value string\">\"su\"</span> \n<span class=\"param-enum-value string\">\"pbrun\"</span> \n<span class=\"param-enum-value string\">\"privileged-exec\"</span> \n</div> \n<div class=\"redoc-markdown-block\">\n<p>\nElevate scan engine permissions to administrative or root access, which is necessary to obtain certain data during the scan. Defaults to <code>\"none\"</code> if not specified. </p>\n</div>\n</div>\n<div class=\"property-info\"> \n<span class=\"property-name\">permissionElevationUsername</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\">\n<p>\nThe user name for the account with elevated permissions. This property must not be specified when the property <code>permissionElevation</code> is set to either <code>\"none\"</code> or <code>\"pbrun\"</code>; otherwise the property is required.</p>\n</div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\">\n<p>\nThe password for the account with elevated permissions. This property must not be specified when the property <code>permissionElevation</code> is set to either <code>\"none\"</code> or <code>\"pbrun\"</code>; otherwise the property is required.<strong>Note: This property is not returned in responses for security.</strong></p>\n</div>\n</div> \n</div>\n\n`ssh-key` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">privateKeyPassword</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The password for private key. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">pemKey</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The PEM-format private key. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">permissionElevation</span> <span class=\"param-type\">string</span> \n<div class=\"param-enum\"> \n<span class=\"param-enum-value string\">\"none\"</span> \n<span class=\"param-enum-value string\">\"sudo\"</span> \n<span class=\"param-enum-value string\">\"sudosu\"</span> \n<span class=\"param-enum-value string\">\"su\"</span> \n<span class=\"param-enum-value string\">\"pbrun\"</span> \n<span class=\"param-enum-value string\">\"privileged-exec\"</span> \n</div> \n<div class=\"redoc-markdown-block\">\n<p>\nElevate scan engine permissions to administrative or root access, which is necessary to obtain certain data during the scan. Defaults to <code>\"none\"</code> if not specified. </p>\n</div>\n</div>\n<div class=\"property-info\"> \n<span class=\"property-name\">permissionElevationUsername</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\">\n<p>\nThe user name for the account with elevated permissions. This property must not be specified when the property <code>permissionElevation</code> is set to either <code>\"none\"</code> or <code>\"pbrun\"</code>; otherwise the property is required.</p>\n</div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\">\n<p>\nThe password for the account with elevated permissions. This property must not be specified when the property <code>permissionElevation</code> is set to either <code>\"none\"</code> or <code>\"pbrun\"</code>; otherwise the property is required.<strong>Note: This property is not returned in responses for security.</strong></p>\n</div>\n</div> \n</div>\n\n`sybase` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">database</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The name of the database. If not specified, a default database name will be used during authentication.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">useWindowsAuthentication</span> <span class=\"param-type\">boolean</span> \n<div class=\"redoc-markdown-block\">\n<p>\nBoolean flag signaling whether to connect to the database using Windows authentication. When set to <code>true</code>, Windows authentication is attempted; when set to <code>false</code>, SQL authentication is attempted.</p>\n</div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">domain</span> <span class=\"param-type\">string</span> \n<div class=\"redoc-markdown-block\"><p>The address of the domain. This property cannot be specified unless property <code>useWindowsAuthentication</code> is set to <code>true</code>.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n`telnet` supported properties:\n<div class=\"properties\"> \n<div class=\"property-info\"> \n<span class=\"property-name\">username</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The user name for the account that will be used for authenticating.</p></div>\n</div> \n<div class=\"property-info\"> \n<span class=\"property-name\">password</span> <span class=\"param-type\">string</span> <span _ngcontent-c21 class=\"param-required\">Required</span> \n<div class=\"redoc-markdown-block\"><p>The password for the account that will be used for authenticating. <strong>Note: This property is not returned in responses for security.</strong></p></div>\n</div> \n</div>\n\n"
        $ref: '#/definitions/Account'
      description:
        type: string
        example: ''
        description: The description of the credential.
      enabled:
        type: boolean
        example: false
        description: Flag indicating whether the credential is enabled for use during the scan.
      hostRestriction:
        type: string
        example: ''
        description: The host name or IP address that you want to restrict the credentials to.
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the credential.
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The name of the credential.
      portRestriction:
        type: integer
        format: int32
        example: ''
        description: Further restricts the credential to attempt to authenticate on a specific port. The port can only be restricted if the property `hostRestriction` is specified.
        minimum: 1
        maximum: 65535
    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: ''
  Tag:
    type: object
    required:
    - name
    - type
    properties:
      color:
        type: string
        example: default
        description: The color to use when rendering the tag in a user interface.
      created:
        type: string
        example: '2017-10-07T23:50:01.205Z'
        description: The date and time the tag was created.
      id:
        type: integer
        format: int32
        example: 6
        description: The identifier of the tag.
        readOnly: true
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: My Custom Tag
        description: The name (label) of the tab.
      riskModifier:
        type: number
        format: double
        example: 2.0
        description: 'The amount to adjust risk of an asset tagged with this tag. '
      searchCriteria:
        $ref: '#/definitions/SearchCriteria'
      source:
        type: string
        example: custom
        description: The source of the tag.
        readOnly: true
        enum:
        - built-in
        - custom
      type:
        type: string
        example: custom
        description: The type of the tag.
    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: ''
  AssetVulnerabilities:
    type: object
    properties:
      critical:
        type: integer
        format: int64
        example: 16
        description: The number of critical vulnerabilities.
        readOnly: true
      exploits:
        type: integer
        format: int64
        example: 4
        description: The number of distinct exploits that can exploit any of the vulnerabilities on the asset.
        readOnly: true
      malwareKits:
        type: integer
        format: int64
        example: 0
        description: The number of distinct malware kits that vulnerabilities on the asset are susceptible to.
        readOnly: true
      moderate:
        type: integer
        format: int64
        example: 3
        description: The number of moderate vulnerabilities.
        readOnly: true
      severe:
        type: integer
        format: int64
        example: 76
        description: The number of severe vulnerabilities.
        readOnly: true
      total:
        type: integer
        format: int64
        example: 95
        description: The total number of vulnerabilities.
        readOnly: true
    description: ''
  SoftwareCpe:
    type: object
    required:
    - part
    properties:
      edition:
        type: string
        example: enterprise
        description: 'Edition-related terms applied by the vendor to the product. '
      language:
        type: string
        example: ''
        description: Defines the language supported in the user interface of the product being described. The format is of the language tag adheres to <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5646">RFC5646</a>.
      other:
        type: string
        example: ''
        description: 'Captures any other general descriptive or identifying information which is vendor- or product-specific and which does not logically fit in any other attribute value. '
      part:
        type: string
        example: o
        description: A single letter code that designates the particular platform part that is being identified.
        enum:
        - o
        - a
        - h
      product:
        type: string
        example: windows_server_2008
        description: the most common and recognizable title or name of the product.
      swEdition:
        type: string
        example: ''
        description: 'Characterizes how the product is tailored to a particular market or class of end users. '
      targetHW:
        type: string
        example: ''
        description: 'Characterize the instruction set architecture on which the product operates. '
      targetSW:
        type: string
        example: ''
        description: Characterize the software computing environment within which the product operates.
      update:
        type: string
        example: sp1
        description: Vendor-specific alphanumeric strings characterizing the particular update, service pack, or point release of the product.
      v2.2:
        type: string
        example: cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise
        description: The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="https://cpe.mitre.org/files/cpe-specification_2.2.pdf">CPE 2.2</a> format.
      v2.3:
        type: string
        example: cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*
        description: The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="http://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf">CPE 2.3</a> format.
      vendor:
        type: string
        example: microsoft
        description: The person or organization that manufactured or created the product.
      version:
        type: string
        example: '-'
        description: Vendor-specific alphanumeric strings characterizing the particular release version of the product.
    description: ''
  DiscoverySearchCriteria:
    type: object
    properties:
      connectionType:
        type: string
        example: ''
        description: The type of discovery connection configured for the site. This property only applies to dynamic sites.
        enum:
        - activesync-ldap
        - activesync-office365
        - activesync-powershell
        - aws
        - dhcp
        - sonar
        - vsphere
      filters:
        type: array
        description: Filters used to match assets from a discovery connection. See <a href="#section/Responses/DiscoverySearchCriteria">Discovery Connection Search Criteria</a> for more information on the structure and format.
        items:
          $ref: '#/definitions/SwaggerDiscoverySearchCriteriaFilter'
      match:
        type: string
        example: all
        description: Operator to determine how to match filters. `all` requires that all filters match for an asset to be included. `any` requires only one filter to match for an asset to be included.
        enum:
        - any
        - all
    description: ''
  Resources«Alert»:
    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/Alert'
    description: ''
  GroupAccount:
    type: object
    required:
    - name
    properties:
      id:
        type: integer
        format: int32
        example: 972
        description: The identifier of the user group.
      name:
        type: string
        example: Administrators
        description: The name of the user group.
    description: ''
  SearchCriteria:
    type: object
    properties:
      filters:
        type: array
        description: Filters used to match assets. See <a href="#section/Responses/SearchCriteria">Search Criteria</a> for more information on the structure and format.
        items:
          $ref: '#/definitions/SwaggerSearchCriteriaFilter'
      match:
        type: string
        example: all
        description: Operator to determine how to match filters. `all` requires that all filters match for an asset to be included. `any` requires only one filter to match for an asset to be included.
        enum:
        - any
        - all
    description: ''
  Address:
    type: object
    properties:
      ip:
        type: string
        example: 123.245.34.235
        description: The IPv4 or IPv6 address.
      mac:
        type: string
        example: 12:34:56:78:90:AB
        description: The Media Access Control (MAC) address. The format is six groups of two hexadecimal digits separated by colons.
    description: ''
  User:
    type: object
    required:
    - login
    - name
    properties:
      authentication:
        example: ''
        description: The authentication source used to authenticate the user.
        readOnly: true
        $ref: '#/definitions/AuthenticationSource'
      email:
        type: string
        example: ''
        description: The email address of the user.
      enabled:
        type: boolean
        example: false
        description: Whether the user account is enabled.
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the user.
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      locale:
        example: ''
        description: The locale and language preferences for the user.
        $ref: '#/definitions/LocalePreferences'
      locked:
        type: boolean
        example: false
        description: Whether the user account is locked (exceeded maximum password retry attempts).
        readOnly: true
      login:
        type: string
        example: ''
        description: The login name of the user.
      name:
        type: string
        example: ''
        description: The full name of the user.
      role:
        example: ''
        description: The privileges and role the user is assigned.
        $ref: '#/definitions/UserRole'
    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: ''
  ScanSchedule:
    type: object
    required:
    - enabled
    - onScanRepeat
    - start
    properties:
      assets:
        example: ''
        description: Allows one or more assets defined within the site to be scanned for this scan schedule. This property is only supported for static sites. When this property is `null`, or not defined in schedule, then all assets defined in the static site will be scanned.
        $ref: '#/definitions/ScheduledScanTargets'
      duration:
        type: string
        example: ''
        description: "Specifies the maximum duration the scheduled scan is allowed to run. Scheduled scans that do not complete within specified duration will be paused. The scan duration are represented by the format `\"P[n]DT[n]H[n]M\"`. In these representations, the [n] is replaced by a value for each of the date and time elements that follow the [n].The following table describes each supported value: \n| Value | Description | \n| ---------- | ---------------- | \n| P | The duration designator. It must be placed at the start of the duration representation. | \n| D | The day designator that follows the value for the number of days. | \n| T | The time designator that precedes the time portion of the representation. | \n| H | The hour designator that follows the value for the number of hours. | \n| M | The minute designator that follows the value for the number of minutes. | \nFor example, `\"P5DT10H30M\"` represents a duration of \"5 days, 10 hours, and 30 minutes\". Each duration designator is optional; however, at least one must be specified and it must be preceded by the `\"P\"` designator. \n"
      enabled:
        type: boolean
        example: false
        description: Flag indicating whether the scan schedule is enabled.
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the scan schedule.
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      nextRuntimes:
        type: array
        description: 'List the next 10 dates in the future the schedule will launch. '
        readOnly: true
        items:
          type: string
      onScanRepeat:
        type: string
        example: ''
        description: "Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration. The following table describes each supported value: \n| Value | Description | \n| ---------- | ---------------- | \n| restart-scan | Stops the previously-paused scan and launches a new scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched. | \n| resume-scan | Resumes the previously-paused scan if the previous scan did not complete within the specified duration. If the previous scheduled scan was not paused, then a new scan is launched. | \n"
      repeat:
        example: ''
        description: Settings for repeating a scheduled scan.
        $ref: '#/definitions/Repeat'
      scanEngineId:
        type: integer
        format: int32
        example: ''
        description: The identifier of the scan engine to be used for this scan schedule. If not set, the site's assigned scan engine will be used.
      scanName:
        type: string
        example: ''
        description: A user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Scan names must be unique within the site's scan schedules.
      scanTemplateId:
        type: string
        example: ''
        description: The identifier of the scan template to be used for this scan schedule. If not set, the site's assigned scan template will be used.
      start:
        type: string
        example: '2018-03-01T04:31:56Z'
        description: The scheduled start date and time. Date is represented in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time.
    description: ''
  LocalePreferences:
    type: object
    properties:
      default:
        type: string
        example: ''
        description: The default language to use. The format is a <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/bcp47">IETF BCP 47</a> language tag.
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      reports:
        type: string
        example: ''
        description: The language to use to generate reports. The format is a <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/bcp47">IETF BCP 47</a> language tag.
    description: ''
  Resources«SiteSharedCredential»:
    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/SiteSharedCredential'
    description: ''
  Software:
    type: object
    properties:
      configurations:
        type: array
        description: The attributes of the software.
        items:
          $ref: '#/definitions/Configuration'
      cpe:
        example: ''
        description: The Common Platform Enumeration (CPE) of the software.
        $ref: '#/definitions/SoftwareCpe'
      description:
        type: string
        example: Microsoft Outlook 2013 15.0.4867.1000
        description: The description of the software.
      family:
        type: string
        example: Office 2013
        description: The family of the software.
      id:
        type: integer
        format: int64
      product:
        type: string
        example: Outlook 2013
        description: The product of the software.
      type:
        type: string
        example: Productivity
        description: The version of the software.
      vendor:
        type: string
        example: Microsoft
        description: The vendor of the software.
      version:
        type: string
        example: 15.0.4867.1000
        description: The version of the software.
    description: ''
  ReferenceWith«UserID,Link»:
    type: object
    properties:
      id:
        type: integer
        format: int32
        example: <id>
        description: The identifier of the resource.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    description: ''
  PageOf«Site»:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      page:
        example: ''
        description: The details of pagination indicating which page was returned, and how the remaining pages can be retrieved.
        $ref: '#/definitions/PageInfo'
      resources:
        type: array
        description: The page of resources returned.
        items:
          $ref: '#/definitions/Site'
    description: ''
  ScanScope:
    type: object
    properties:
      assets:
        example: ''
        description: Specify assets to be included in site scans as well as assets to be excluded from site scans. If the property is defined, then at least one address or asset group must be specified for scanning. Property is required when creating a static site.
        $ref: '#/definitions/StaticSite'
      connection:
        example: ''
        description: Specify discovery connection settings for a dynamic site. Property is required when creating a dynamic site.
        $ref: '#/definitions/DynamicSite'
    description: ''
  StaticSite:
    type: object
    properties:
      excludedAssetGroups:
        example: ''
        description: Assets associated with these asset groups will be excluded from the site's scan.
        $ref: '#/definitions/ExcludedAssetGroups'
      excludedTargets:
        example: ''
        description: Addresses to be excluded from the site's scan. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        $ref: '#/definitions/ExcludedScanTargets'
      includedAssetGroups:
        example: ''
        description: Assets associated with these asset groups will be included in the site's scan.
        $ref: '#/definitions/IncludedAssetGroups'
      includedTargets:
        example: ''
        description: Addresses to be included in the site's scan. At least one address must be specified in a static site. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        $ref: '#/definitions/IncludedScanTargets'
    description: ''
  DynamicSite:
    type: object
    required:
    - id
    properties:
      id:
        type: integer
        format: int64
        example: ''
        description: The identifier of the discovery connection.
    description: ''
  WebFormAuthentication:
    type: object
    properties:
      baseURL:
        type: string
        example: ''
        description: 'The base URL is the main address from which all paths in the target Web site begin. Includes the protocol. Example: http://acme.com.'
      enabled:
        type: boolean
        example: false
        description: Flag indicating whether the HTML form web authentication is enabled for the site's scans.
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the HTML form web authentication.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      loginRegularExpression:
        type: string
        example: ''
        description: The regular expression matches the message that the Web server returns if the login attempt fails.
      loginURL:
        type: string
        example: ''
        description: 'The login page URL contains form for logging on. Include the base URL. Example: http://acme.com/login.'
      name:
        type: string
        example: ''
        description: The HTML form web authentication name.
      service:
        type: string
        example: ''
        description: Value indicating whether this web authentication  configuration is for HTML form authentication or HTTP header authentication.
        enum:
        - html-form
        - http-header
    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: ''
  Service:
    type: object
    required:
    - port
    - protocol
    properties:
      configurations:
        type: array
        description: Configuration key-values pairs enumerated on the service.
        items:
          $ref: '#/definitions/Configuration'
      databases:
        type: array
        description: The databases enumerated on the service.
        items:
          $ref: '#/definitions/Database'
      family:
        type: string
        example: ''
        description: The family of the service.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: CIFS Name Service
        description: The name of the service.
      port:
        type: integer
        format: int32
        example: 139
        description: The port of the service.
      product:
        type: string
        example: Samba
        description: The product running the service.
      protocol:
        type: string
        example: tcp
        description: The protocol of the service.
        enum:
        - ip
        - icmp
        - igmp
        - ggp
        - tcp
        - pup
        - udp
        - idp
        - esp
        - nd
        - raw
      userGroups:
        type: array
        description: The group accounts enumerated on the service.
        items:
          $ref: '#/definitions/GroupAccount'
      users:
        type: array
        description: The user accounts enumerated on the service.
        items:
          $ref: '#/definitions/UserAccount'
      vendor:
        type: string
        example: ''
        description: The vendor of the service.
      version:
        type: string
        example: 3.5.11
        description: The version of the service.
      webApplications:
        type: array
        description: The web applications found on the service.
        items:
          $ref: '#/definitions/WebApplication'
    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: ''
  OperatingSystemCpe:
    type: object
    required:
    - part
    properties:
      edition:
        type: string
        example: enterprise
        description: 'Edition-related terms applied by the vendor to the product. '
      language:
        type: string
        example: ''
        description: Defines the language supported in the user interface of the product being described. The format is of the language tag adheres to <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5646">RFC5646</a>.
      other:
        type: string
        example: ''
        description: 'Captures any other general descriptive or identifying information which is vendor- or product-specific and which does not logically fit in any other attribute value. '
      part:
        type: string
        example: o
        description: A single letter code that designates the particular platform part that is being identified.
        enum:
        - o
        - a
        - h
      product:
        type: string
        example: windows_server_2008
        description: the most common and recognizable title or name of the product.
      swEdition:
        type: string
        example: ''
        description: 'Characterizes how the product is tailored to a particular market or class of end users. '
      targetHW:
        type: string
        example: ''
        description: 'Characterize the instruction set architecture on which the product operates. '
      targetSW:
        type: string
        example: ''
        description: Characterize the software computing environment within which the product operates.
      update:
        type: string
        example: sp1
        description: Vendor-specific alphanumeric strings characterizing the particular update, service pack, or point release of the product.
      v2.2:
        type: string
        example: cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise
        description: The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="https://cpe.mitre.org/files/cpe-specification_2.2.pdf">CPE 2.2</a> format.
      v2.3:
        type: string
        example: cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*
        description: The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="http://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf">CPE 2.3</a> format.
      vendor:
        type: string
        example: microsoft
        description: The person or organization that manufactured or created the product.
      version:
        type: string
        example: '-'
        description: Vendor-specific alphanumeric strings characterizing the particular release version of the product.
    description: ''
  SyslogAlert:
    type: object
    required:
    - enabled
    - name
    - notification
    - server
    properties:
      enabled:
        type: boolean
        example: false
        description: Flag indicating the alert is enabled.
      enabledScanEvents:
        example: ''
        description: Allows the user to specify which scan events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledScanEvents`.
        $ref: '#/definitions/ScanEvents'
      enabledVulnerabilityEvents:
        example: ''
        description: Allows the user to specify which vulnerability result events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledVulnerabilityEvents`.
        $ref: '#/definitions/VulnerabilityEvents'
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the alert.
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      maximumAlerts:
        type: integer
        format: int32
        example: ''
        description: The maximum number of alerts that will be issued. To disable maximum alerts, omit the property in the request or specify the property with a value of `null`.
        minimum: 1
      name:
        type: string
        example: ''
        description: The name of the alert.
      notification:
        type: string
        example: ''
        description: The type of alert.
        enum:
        - SMTP
        - SNMP
        - Syslog
      server:
        type: string
        example: ''
        description: The Syslog server to send messages to.
    description: ''
  ExcludedScanTargets:
    type: object
    properties:
      addresses:
        type: array
        description: List of addresses. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        items:
          type: string
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
    description: ''
  OperatingSystem:
    type: object
    properties:
      architecture:
        type: string
        example: x86
        description: The architecture of the operating system.
      configurations:
        type: array
        description: Configuration key-values pairs enumerated on the operating system.
        items:
          $ref: '#/definitions/Configuration'
      cpe:
        example: ''
        description: The Common Platform Enumeration (CPE) of the operating system.
        $ref: '#/definitions/OperatingSystemCpe'
      description:
        type: string
        example: Microsoft Windows Server 2008 Enterprise Edition SP1
        description: The description of the operating system (containing vendor, family, product, version and architecture in a single string).
      family:
        type: string
        example: Windows
        description: The family of the operating system.
      id:
        type: integer
        format: int64
        example: 35
        description: The identifier of the operating system.
      product:
        type: string
        example: Windows Server 2008 Enterprise Edition
        description: The name of the operating system.
      systemName:
        type: string
        example: Microsoft Windows
        description: A combination of vendor and family (with redundancies removed), suitable for grouping.
      type:
        type: string
        example: Workstation
        description: The type of operating system.
      vendor:
        type: string
        example: Microsoft
        description: The vendor of the operating system.
      version:
        type: string
        example: SP1
        description: The version of the operating system.
    description: ''
  SiteDiscoveryConnection:
    type: object
    properties:
      id:
        type: integer
        format: int64
        example: ''
        description: The identifier of the discovery connection.
        readOnly: true
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      name:
        type: string
        example: ''
        description: The name of the discovery connection.
        readOnly: true
      type:
        type: string
        example: ''
        description: The type of discovery connection configured for the site. This property only applies to dynamic sites.
        readOnly: true
        enum:
        - activesync-ldap
        - activesync-office365
        - activesync-powershell
        - aws
        - dhcp
        - sonar
        - vsphere
    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: ''
  Resources«AssetGroup»:
    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/AssetGroup'
    description: ''
  ExcludedAssetGroups:
    type: object
    properties:
      assetGroupIDs:
        type: array
        description: List of asset group identifiers. Each element is an integer.
        items:
          type: integer
          format: int32
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
    description: ''
  Resources«WebHeaderAuthentication»:
    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/WebHeaderAuthentication'
    description: ''
  ReferenceWith«SiteID,Link»:
    type: object
    properties:
      id:
        type: integer
        format: int32
        example: <id>
        description: The identifier of the resource.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    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: ''
  VulnerabilityEvents:
    type: object
    required:
    - confirmedVulnerabilities
    - potentialVulnerabilities
    - unconfirmedVulnerabilities
    - vulnerabilitySeverity
    properties:
      confirmedVulnerabilities:
        type: boolean
        example: false
        description: Generates an alert for vulnerability results of confirmed vulnerabilties. A vulnerability is "confirmed" when asset-specific vulnerability tests, such as exploits, produce positive results. Default value is `true`.
      potentialVulnerabilities:
        type: boolean
        example: false
        description: Generates an alert for vulnerability results of potential vulnerabilties. A vulnerability is "potential" if a check for a potential vulnerabilty is positive. Default value is `true`.
      unconfirmedVulnerabilities:
        type: boolean
        example: false
        description: Generates an alert for vulnerability results of unconfirmed vulnerabilties. A vulnerability is "unconfirmed" when a version of a scanned service or software is known to be vulnerable, but there is no positive verification. Default value is `true`.
      vulnerabilitySeverity:
        type: string
        example: ''
        description: Generates an alert for vulnerability results of the selected vulnerability severity. Default value is `"any_severity"`.
        enum:
        - any_severity
        - severe_and_critical
        - only_critical
    description: ''
  Resources«SmtpAlert»:
    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/SmtpAlert'
    description: ''
  ScheduledScanTargets:
    type: object
    properties:
      excludedAssetGroups:
        example: ''
        description: Assets associated with these asset groups will be excluded from the site's scan.
        $ref: '#/definitions/ExcludedAssetGroups'
      excludedTargets:
        example: ''
        description: Addresses to be excluded from the site's scan. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation.
        $ref: '#/definitions/ExcludedScanTargets'
      includedAssetGroups:
        example: ''
        description: Allows users to specify a subset of the site's included asset groups to be included in the scan. If the property is defined, then at least one valid already defined as an included asset group must be specified.
        $ref: '#/definitions/IncludedAssetGroups'
      includedTargets:
        example: ''
        description: Allows users to specify a subset of the site's scan targets to be included in the scan. If the property is defined, then at least one address must be specified.
        $ref: '#/definitions/IncludedScanTargets'
    description: ''
  UserAccount:
    type: object
    properties:
      fullName:
        type: string
        example: Smith, John
        description: The full name of the user account.
      id:
        type: integer
        format: int32
        example: 8952
        description: The identifier of the user account.
      name:
        type: string
        example: john_smith
        description: The name of the user account.
    description: ''
  WebHeaderAuthentication:
    type: object
    properties:
      baseURL:
        type: string
        example: ''
        description: 'The base URL is the main address from which all paths in the target Web site begin. Includes the protocol. Example: http://acme.com.'
      enabled:
        type: boolean
        example: false
        description: Flag indicating whether the HTTP header web authentication is enabled for the site's scans.
      headers:
        type: object
        example: ''
        description: 'A map of HTTP headers the scan engine will use when negotiating with the Web server for an "authenticated" page. Make sure that the session ID is valid between the time you save this ID for the site and when you start the scan. Note: This property is not returned in responses for security.'
        additionalProperties:
          type: string
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the HTTP header web authentication.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      loginRegularExpression:
        type: string
        example: ''
        description: The regular expression matches the message that the Web server returns if the login attempt fails.
      name:
        type: string
        example: ''
        description: The HTTP header web authentication name.
      service:
        type: string
        example: ''
        description: Value indicating whether this web authentication  configuration is for HTML form authentication or HTTP header authentication.
        enum:
        - html-form
        - http-header
    description: ''
  Resources«SyslogAlert»:
    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/SyslogAlert'
    description: ''
  ReferenceWith«AlertID,Link»:
    type: object
    properties:
      id:
        type: integer
        format: int32
        example: <id>
        description: The identifier of the resource.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    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: ''
  Vulnerabilities:
    type: object
    properties:
      critical:
        type: integer
        format: int64
        example: 16
        description: The number of critical vulnerabilities.
        readOnly: true
      moderate:
        type: integer
        format: int64
        example: 3
        description: The number of moderate vulnerabilities.
        readOnly: true
      severe:
        type: integer
        format: int64
        example: 76
        description: The number of severe vulnerabilities.
        readOnly: true
      total:
        type: integer
        format: int64
        example: 95
        description: The total number of vulnerabilities.
        readOnly: true
    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: ''
  SwaggerDiscoverySearchCriteriaFilter:
    type: object
    properties:
      field:
        type: string
        example: ''
        description: The filter field for the search criteria.
      lower:
        type: object
        example: ''
        description: The lower value to match in a range criteria.
      operator:
        type: string
        example: ''
        description: The operator on how to match the search criteria.
      upper:
        type: object
        example: ''
        description: The upper value to match in a range criteria.
      value:
        type: object
        example: ''
        description: The single value to match using the operator.
      values:
        type: array
        description: An array of values to match using the operator.
        items:
          type: object
    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: ''
  WebPage:
    type: object
    properties:
      linkType:
        type: string
        example: html-ref
        description: The type of link used to traverse or detect the page.
        enum:
        - seed
        - html-ref
        - robots
        - js-string
        - query-param
        - pdf
        - css
        - implied-dir
        - rss
        - redirection
        - sitemap
        - backup
        - vck-rewrite
        - non-ref-guess
        - soft-404
      path:
        type: string
        example: /docs/config/index.html
        description: The path to the page (URI).
      response:
        type: integer
        format: int32
        example: 200
        description: The HTTP response code observed with retrieving the page.
    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: ''
  Asset:
    type: object
    properties:
      addresses:
        type: array
        description: All addresses discovered on the asset.
        items:
          $ref: '#/definitions/Address'
      assessedForPolicies:
        type: boolean
        example: false
        description: Whether the asset has been assessed for policies at least once.
        readOnly: true
      assessedForVulnerabilities:
        type: boolean
        example: true
        description: Whether the asset has been assessed for vulnerabilities at least once.
        readOnly: true
      configurations:
        type: array
        description: Configuration key-values pairs enumerated on the asset.
        items:
          $ref: '#/definitions/Configuration'
      databases:
        type: array
        description: The databases enumerated on the asset.
        items:
          $ref: '#/definitions/Database'
      files:
        type: array
        description: The files discovered with searching on the asset.
        items:
          $ref: '#/definitions/File'
      history:
        type: array
        description: The history of changes to the asset over time.
        readOnly: true
        items:
          $ref: '#/definitions/AssetHistory'
      hostName:
        type: string
        example: corporate-workstation-1102DC.acme.com
        description: The primary host name (local or FQDN) of the asset.
      hostNames:
        type: array
        description: All host names or aliases discovered on the asset.
        items:
          $ref: '#/definitions/HostName'
      id:
        type: integer
        format: int64
        example: 282
        description: The identifier of the asset.
      ids:
        type: array
        description: Unique identifiers found on the asset, such as hardware or operating system identifiers.
        items:
          $ref: '#/definitions/UniqueId'
      ip:
        type: string
        example: 182.34.74.202
        description: The primary IPv4 or IPv6 address of the asset.
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        readOnly: true
        items:
          $ref: '#/definitions/Link'
      mac:
        type: string
        example: AB:12:CD:34:EF:56
        description: The primary Media Access Control (MAC) address of the asset. The format is six groups of two hexadecimal digits separated by colons.
      os:
        type: string
        example: Microsoft Windows Server 2008 Enterprise Edition SP1
        description: The full description of the operating system of the asset.
      osFingerprint:
        example: ''
        description: The details of the operating system of the asset.
        $ref: '#/definitions/OperatingSystem'
      rawRiskScore:
        type: number
        format: double
        example: 31214.3
        description: The base risk score of the asset.
        readOnly: true
      riskScore:
        type: number
        format: double
        example: 37457.16
        description: The risk score (with criticality adjustments) of the asset.
        readOnly: true
      services:
        type: array
        description: The services discovered on the asset.
        items:
          $ref: '#/definitions/Service'
      software:
        type: array
        description: The software discovered on the asset.
        items:
          $ref: '#/definitions/Software'
      type:
        type: string
        example: ''
        description: The type of asset.
        enum:
        - unknown
        - guest
        - hypervisor
        - physical
        - mobile
      userGroups:
        type: array
        description: The group accounts enumerated on the asset.
        items:
          $ref: '#/definitions/GroupAccount'
      users:
        type: array
        description: The user accounts enumerated on the asset.
        items:
          $ref: '#/definitions/UserAccount'
      vulnerabilities:
        example: ''
        description: Summary information for vulnerabilities on the asset.
        readOnly: true
        $ref: '#/definitions/AssetVulnerabilities'
    description: ''
  SmtpAlert:
    type: object
    required:
    - enabled
    - name
    - notification
    - recipients
    - relayServer
    properties:
      enabled:
        type: boolean
        example: false
        description: Flag indicating the alert is enabled.
      enabledScanEvents:
        example: ''
        description: Allows the user to specify which scan events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledScanEvents`.
        $ref: '#/definitions/ScanEvents'
      enabledVulnerabilityEvents:
        example: ''
        description: Allows the user to specify which vulnerability result events generate an alert. Default values will be chosen if property is not specified as apart of the request. The default values are documented in the properties of `enabledVulnerabilityEvents`.
        $ref: '#/definitions/VulnerabilityEvents'
      id:
        type: integer
        format: int32
        example: ''
        description: The identifier of the alert.
      limitAlertText:
        type: boolean
        example: false
        description: Reports basic information in the alert, if enabled.
      links:
        type: array
        items:
          $ref: '#/definitions/Link'
      maximumAlerts:
        type: integer
        format: int32
        example: ''
        description: The maximum number of alerts that will be issued. To disable maximum alerts, omit the property in the request or specify the property with a value of `null`.
        minimum: 1
      name:
        type: string
        example: ''
        description: The name of the alert.
      notification:
        type: string
        example: ''
        description: The type of alert.
        enum:
        - SMTP
        - SNMP
        - Syslog
      recipients:
        type: array
        description: The recipient list. At least one recipient must be specified. Each recipient must be a valid e-mail address.
        items:
          type: string
      relayServer:
        type: string
        example: ''
        description: The SMTP server/relay to send messages through.
      senderEmailAddress:
        type: string
        example: ''
        description: The sender e-mail address that will appear in the from field.
    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: ''