openapi: 3.1.0
info:
  title: InsightAppSec Accounts Asset Group 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: Asset Group
  description: Resources and operations for managing asset groups.
paths:
  /api/3/agents:
    get:
      tags:
      - Asset Group
      summary: Agents
      description: Returns the details for all agents.
      operationId: getAgents
      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«Agent»'
          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/asset_groups:
    get:
      tags:
      - Asset Group
      summary: Asset Groups
      description: Returns all asset groups.
      operationId: getAssetGroups
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: type
        in: query
        description: The type of asset group.
        required: false
        type: string
      - name: name
        in: query
        description: A search pattern for the name of the asset group. Searches are case-insensitive contains.
        required: false
        type: string
      - 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«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: []
    post:
      tags:
      - Asset Group
      summary: Asset Groups
      description: "Creates a new asset group. The `searchCriteria` field can be passed no matter what the type of the asset group is. The asset group `type` changes when the assets are refreshed. Dynamic asset groups constantly refreshed their membership as assets are scanned whereas static asset groups do not change membership automatically. \nSee the <a href=\"#section/Responses/SearchCriteria\">Search Criteria</a> for more information on using dynamic criteria."
      operationId: createAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: assetGroup
        description: The details of the asset group.
        required: false
        schema:
          $ref: '#/definitions/AssetGroup'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/CreatedReference«AssetGroupID,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: An Empty Static Asset Group
        source: "{\n    \"description\": \"A Static Asset Group With No Assets. In order to add assets to this group you can POST to the /assets endpoint or PUT to the /assets/{assetID} endpoint.\",\n    \"name\": \"Empty Static Asset Groups\",\n    \"type\": \"static\"\n}"
      - lang: A static asset group with assets defined by search criteria
        source: "{\n    \"description\": \"A Static Asset Group with Assets that are Linux Assets running Containers (With Low Access Complexity Vulnerabilities) for remediation purposes.\",\n    \"name\": \"Container Hosts - Linux\",\n    \"searchCriteria\": {\n        \"filters\": [\n            { \"field\": \"operating-system\", \"operator\": \"contains\", \"value\": \"linux\" },\n            { \"field\": \"containers\", \"operator\": \"are\", \"value\": 0 },\n            { \"field\": \"cvss-access-complexity\", \"operator\": \"is\", \"value\": \"L\" }\n        ],\n        \"match\": \"all\"\n    },\n    \"type\": \"static\"\n}"
      - lang: A dynamic asset group
        source: "{\n    \"description\": \"A Static Asset Group with Assets that are Linux Assets running Containers (With Low Access Complexity Vulnerabilities) for remediation purposes.\",\n    \"name\": \"Container Hosts - Linux\",\n    \"searchCriteria\": {\n        \"filters\": [\n            { \"field\": \"operating-system\", \"operator\": \"contains\", \"value\": \"linux\" },\n            { \"field\": \"containers\", \"operator\": \"are\", \"value\": 0 },\n            { \"field\": \"cvss-access-complexity\", \"operator\": \"is\", \"value\": \"L\" }\n        ],\n        \"match\": \"all\"\n    },\n    \"type\": \"dynamic\"\n}"
  /api/3/asset_groups/{id}:
    get:
      tags:
      - Asset Group
      summary: Asset Group
      description: Returns an asset group.
      operationId: getAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/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:
      - Asset Group
      summary: Asset Group
      description: Updates the details of an asset group. See the search criteria endpoint (/search_criteria) for more information about building the search criteria and examples.
      operationId: updateAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      - in: body
        name: assetGroup
        description: The details of the asset group.
        required: false
        schema:
          $ref: '#/definitions/AssetGroup'
      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:
      - Asset Group
      summary: Asset Group
      description: Deletes the asset group.
      operationId: deleteAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        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/asset_groups/{id}/assets:
    get:
      tags:
      - Asset Group
      summary: Asset Group Assets
      description: Returns hypermedia links for the assets that belong to an asset group.
      operationId: getAssetGroupAssets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReferencesWith«AssetID,Link»'
          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:
      - Asset Group
      summary: Asset Group Assets
      description: Updates all the assets that belong to a static asset group.
      operationId: updateAssetGroupAssets
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      - in: body
        name: assets
        description: 'The assets to place in the asset group. '
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int64
      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:
      - Asset Group
      summary: Asset Group Assets
      description: Removes the assets from the given static asset group.
      operationId: removeAllAssetsFromAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        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/asset_groups/{id}/assets/{assetId}:
    put:
      tags:
      - Asset Group
      summary: Asset Group Asset
      description: Adds an asset to a static asset group.
      operationId: addAssetToAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        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: {}
        '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:
      - Asset Group
      summary: Asset Group Asset
      description: Removes an asset from an asset group.
      operationId: removeAssetFromAssetGroup
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        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/asset_groups/{id}/search_criteria:
    get:
      tags:
      - Asset Group
      summary: Asset Group Search Criteria
      description: Returns the search criteria of a dynamic asset group.For a reference of valid search criteria input see the <a href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.
      operationId: getAssetGroupSearchCriteria
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchCriteria'
          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:
      - Asset Group
      summary: Asset Group Search Criteria
      description: Updates the search criteria of a dynamic asset group. For a reference of valid search criteria input see the <a href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.
      operationId: setAssetGroupSearchCriteria
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      - in: body
        name: criteria
        description: The search criteria specification.
        required: false
        schema:
          $ref: '#/definitions/SearchCriteria'
      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: []
      x-code-samples:
      - lang: Unassigned PCI Incompliant Windows Assets
        source: "{\n   \"description\": \"This is an asset group that contains assets that have not been recently scanned in our Los Angeles Datacenter that are also high risk.\",\n   \"name\": \"Stale Los Angeles Assets (High Risk)\",\n   \"type\": \"dynamic\",\n   \"searchCriteria\": {\n      \"match\": \"all\",\n      \"filters\": [\n         { \"field\": \"location-tag\", \"operator\": \"contains\", \"value\": \"Los Angeles Datacenter\" },\n         { \"field\": \"risk-score\", \"operator\": \"is-greater-than\", \"value\": 5000 },\n         { \"field\": \"last-scan-date\", \"operator\": \"is-on-or-before\", \"value\": \"2016-12-31\" }\n      ]\n   }\n}"
      - lang: Stale Los Angeles Assets (High Risk)
        source: "{\n   \"description\": \"This is an asset group that contains Windows Assets that are not PCI compliant and not assigned to an owner.\",\n   \"name\": \"Unassigned PCI Incompliant Windows Assets\",\n   \"type\": \"dynamic\",\n   \"searchCriteria\": {\n      \"match\": \"all\",\n      \"filters\": [\n         { \"field\": \"pci-compliance\", \"operator\": \"is\", \"value\": \"0\" },\n         { \"field\": \"owner-tag\", \"operator\": \"is-not-applied\" },\n         { \"field\": \"operating-system\", \"operator\": \"contains\", \"value\": \"windows\" }\n      ]\n   }\n}"
  /api/3/asset_groups/{id}/tags:
    get:
      tags:
      - Asset Group
      summary: Asset Group Tags
      description: Returns the tags assigned to an asset group.
      operationId: getAssetGroupTags
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReferencesWith«TagID,Link»'
          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:
      - Asset Group
      summary: Asset Group Tags
      description: Updates the tags of an asset group.
      operationId: setAssetGroupTags
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      - in: body
        name: tags
        description: The tags to associate to the asset group.
        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: []
    delete:
      tags:
      - Asset Group
      summary: Asset Group Tags
      description: Removes all tag associations from the asset group.
      operationId: removeAllAssetGroupTags
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        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/asset_groups/{id}/tags/{tagId}:
    put:
      tags:
      - Asset Group
      summary: Resources and operations for managing asset groups.
      description: Adds a tag to an asset group.
      operationId: addAssetGroupTag
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        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: {}
        '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:
      - Asset Group
      summary: Resources and operations for managing asset groups.
      description: Removes a tag from an asset group.
      operationId: removeAssetGroupTag
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        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/asset_groups/{id}/users:
    get:
      tags:
      - Asset Group
      summary: Asset Group Users
      description: Returns hypermedia links for the users with access to this asset group.
      operationId: getAssetGroupUsers
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ReferencesWith«UserID,Link»'
          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:
      - Asset Group
      summary: Asset Group Users
      description: Grants users with sufficient privileges access to an asset group.
      operationId: setAssetGroupUsers
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        required: true
        type: integer
        format: int32
      - in: body
        name: users
        description: The users to grant access to the asset group.
        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/asset_groups/{id}/users/{userId}:
    put:
      tags:
      - Asset Group
      summary: Asset Group User
      description: Grants a user with sufficient privileges access to the asset group.
      operationId: addAssetGroupUser
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        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: {}
        '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:
      - Asset Group
      summary: Asset Group User
      description: Removes a user's access from an asset group.
      operationId: removeAssetGroupUser
      schemes: []
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: id
        in: path
        description: The identifier of the asset group.
        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: []
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: ''
  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: ''
  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: ''
  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: ''
  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: ''
  NotFoundError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '404'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '404'
    description: ''
  InternalServerError:
    type: object
    required:
    - status
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      message:
        type: string
        example: An error has occurred.
        description: The messages indicating the cause or reason for failure.
      status:
        type: string
        example: '500'
        description: The HTTP status code for the error (same as in the HTTP response).
        enum:
        - '500'
    description: ''
  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: ''
  PageOf«AssetGroup»:
    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/AssetGroup'
    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: ''
  Links:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
    description: ''
  ReferencesWith«UserID,Link»:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      resources:
        type: array
        description: The identifiers of the associated resources.
        items:
          type: integer
          format: int32
    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: ''
  PageOf«Agent»:
    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/Agent'
    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: ''
  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: ''
  ReferencesWith«TagID,Link»:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      resources:
        type: array
        description: The identifiers of the associated resources.
        items:
          type: integer
          format: int32
    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: ''
  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: ''
  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: ''
  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: ''
  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: ''
  Agent:
    type: object
    required:
    - lastAssessedForVulnerabilities
    properties:
      addresses:
        type: array
        description: All addresses discovered on the asset.
        items:
          $ref: '#/definitions/Address'
      agentId:
        type: string
        example: fe1708451f8c78c3a20a8a79818878e1
        description: The identifier of the agent.
        readOnly: true
      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.
      lastAssessedForVulnerabilities:
        type: string
        example: '2019-09-11T10:39:51.288Z'
        description: The time the last vulnerability assessment occured.
      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: ''
  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: ''
  ReferencesWith«AssetID,Link»:
    type: object
    properties:
      links:
        type: array
        description: Hypermedia links to corresponding or related resources.
        items:
          $ref: '#/definitions/Link'
      resources:
        type: array
        description: The identifiers of the associated resources.
        items:
          type: integer
          format: int64
    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: ''
  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: ''
  CreatedReference«AssetGroupID,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: ''
  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: ''
  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: ''
  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: ''
  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: ''
  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: ''
  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: ''