{
  "openapi": "3.1.0",
  "info": {
    "title": "InsightVM Cloud Integrations API",
    "description": "# Overview \n\nThis guide documents the InsightVM Cloud Integrations Application Programming Interface (API). This API supports the\nRepresentational State Transfer (REST) design pattern. See [Insight Platform API Overview](https://insight.help.rapid7.com/docs/api-overview)\nfor an overview of all Insight Platform APIs.\n\n## Versioning\n\nVersioning is specified in the URL, and the base path of this API is:\n\n`https://{region}.api.insight.rapid7.com/vm/{version}/`\n\nVersion numbers are numerical and prefixed with the letter `\"v\"`, such as `\"v4\"`.\n\nThe region indicates the desired geo-location of the Insight Platform:\n\n | Code | Region                    |\n |------|---------------------------|\n | us   | United States (us-east-1) |\n | us2  | United States (us-east-2) |\n | us3  | United States (us-west-2) |\n | eu   | Europe                    |\n | ca   | Canada                    |\n | au   | Australia                 |\n | ap   | Japan                     |\n | aps2 | India                     |\n | me1  | Middle East               |\n\n## Authorization\n\nAuthorization requires the `X-Api-Key` token header, which can be generated from the [Insight Platform](https://insight.rapid7.com) key management page.\nSee [Insight Platform API Key](https://insight.help.rapid7.com/docs/managing-platform-api-keys) for more details.\n\n## Media Types\n\nUnless otherwise noted, this API accepts and produces the `application/json` and `application/xml` media types.\nUnless otherwise indicated, the default request body media type is `application/json`. \n\n## Verbs and Responses\n\nThe following HTTP operations are supported throughout this API. The general usage of each operation and both\nits failure and success status codes are outlined below. \n \n| <div style=\"width: 70px\">Verb</div>      | Usage                                                                                 | Success     | Failure                                                        |\n| --------- | ------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------- |\n| `GET`     | Used to retrieve a resource by identifier, or a collection of resources by type.      | `200`       | `400`, `401`, `402`, `404`, `405`, `408`, `410`, `415`, `500`  |\n| `POST`    | Creates a resource with an application-specified identifier.                          | `201`       | `400`, `401`, `404`, `405`, `408`, `413`, `415`, `500`         |\n| `POST`    | Performs a request to queue an asynchronous job.                                      | `202`       | `400`, `401`, `405`, `408`, `410`, `413`, `415`, `500`         |\n| `PUT`     | Creates a resource with a client-specified identifier.                                | `200`       | `400`, `401`, `403`, `405`, `408`, `410`, `413`, `415`, `500`  |\n| `PUT`     | Performs a full update of a resource with a specified identifier.                     | `201`       | `400`, `401`, `403`, `405`, `408`, `410`, `413`, `415`, `500`  |\n| `DELETE`  | Deletes a resource by identifier or an entire collection of resources.                | `204`       | `400`, `401`, `405`, `408`, `410`, `413`, `415`, `500`         |\n| `OPTIONS` | Requests what operations are available on a resource.                                 | `200`       | `401`, `404`, `405`, `408`, `500`                              |\n\n## Formats\n\n### Dates & Times\n\nDates and/or times are specified as strings in ISO 8601 format. The following formats are supported as input:\n\n| Value                       | Format                                                 | Notes                                                 |\n| --------------------------- | ------------------------------------------------------ | ----------------------------------------------------- |\n| Date                        | YYYY-MM-DD                                             | Defaults to 12 AM UTC (if used for a date & time)     |\n| Date & time only            | YYYY-MM-DD'T'hh:mm:ss[.nnn]                            | Defaults to UTC                                       |\n| Date & time in UTC          | YYYY-MM-DD'T'hh:mm:ss[.nnn]Z                           |                                                       |\n| Date & time w/ offset       | YYYY-MM-DD'T'hh:mm:ss[.nnn][+&#124;-]hh:mm             |                                                       |\n| Date & time w/ zone-offset  | YYYY-MM-DD'T'hh:mm:ss[.nnn][+&#124;-]hh:mm[<zone-id>]  |                                                       |\n \n### Timezones\n\nTimezones are specified in regional zone format, such as `\"America/Los_Angeles\"`, `\"Asia/Tokyo\"`, or `\"GMT\"`.\n \n### Paging\n\nPagination may be supported on collection resources using two query parameters, `page` and `size`.\nThe `page` parameter specifies the zero-based index of the page to retrieve, and `size` specifies the page size.\n\nFor example, `/resources?page=2&size=10` will return page 3, with 10 records per page, giving results 21-30.\n\nThe maximum page size for a request is 500.\n\nPaging with page and size parameters supports up to 10,000 results. To retrieve results beyond this limit, you must use the `cursor` parameter.\n\nSome paginated endpoints may support \"cursored\" pages, allowing for a guaranteed consistent view of data across page\nboundaries. Cursored page requests support a consistent, sequential way to access data across pages. Only if this option \nis used are you guaranteed to read a record once and only once across pages (\"repeatable read\").\nThe `cursor` property is used to follow the same chain of paginated requests from page to page. Each \nrequest changes the value of the next cursor to use on the subsequent page and may only be used to iterate sequentially\nthrough pages. Cursors are stateless (results may shift across page boundaries while data is being updated) unless otherwise noted.\n\nThe response to a paginated request follows the format:\n\n```json\n{\n   \"data\": [ \n      ... \n   ],\n   \"metadata\": { \n      \"number\": ...,\n      \"size\": ...,\n      \"sort\": ...,\n      \"totalResources\": ...,\n      \"totalPages\": ...,\n      \"cursor\": ...\n   },\n   \"links\": [\n     {\n      \"href\" : ...,\n       \"rel\" : \"first\"\n     }, {\n       \"href\" : ...,\n       \"rel\" : \"self\"\n      }, {\n       \"href\" : ...,\n       \"rel\" : \"next\"\n      }, {\n       \"href\" : ...,\n       \"rel\" : \"last\"\n      }\n   ]\n}\n```\n\nThe `data` property is an array of resources retrieved from the endpoint, each of which should contain at\nminimum a \"self\" relation hypermedia link. The `metadata` property outlines the details of the current page and total\npossible pages. The object for the page includes the following properties:\n\n- `number` - The page number (zero-based) of the page returned.\n- `size` - The size of the pages, which is less than or equal to the maximum page size.\n- `totalResources` - The total amount of resources available across all pages.\n- `totalPages` - The total amount of pages.\n- `cursor` - An optional cursor for \"cursored\" page requests.\n\nThe last property of the paged response is the `links` array, which contains all available hypermedia links. For\npaginated responses, the \"self\", \"next\", \"previous\", \"first\", and \"last\" links are returned. The \"self\" link must\nalways be returned and should contain a link to allow the client to replicate the original request against the \ncollection resource in an identical manner to that in which it was invoked. \n\nThe \"next\" and \"previous\" links are present if there is a next or previous page, respectively.\nThe \"next\" and \"previous\" links include hrefs that allow \"natural movement\" to the next page; that is, all parameters\nrequired to move to the next page are provided in the link. The \"first\" and \"last\" links reference the first\nand last pages, respectively. If the page is \"cursored\", the cursor is automatically incorporated into the pagination links.\n\nFor example, `/resources?page=19&size=500` returns page 20, with 500 records per page, giving results 9501-10000. Using the \"cursor-value\" returned from the previous request, `/resources?page=20&size=500&cursor=<cursor-value>` returns page 21, with 500 records per page, giving results 10001-10500.\n\n### Sorting\n\nSorting is supported on paginated resources with the `sort` query parameter(s). The sort query parameter(s) support\nidentifying a single or multi-property sort with a single or multi-direction output. The format of the parameter is:\n\n```\nsort=property[,ASC|DESC]...\n```\n\nTherefore, the request `/resources?sort=name,title,DESC` returns results sorted by name and title\ndescending, in that order. The sort directions are either ascending `ASC` or descending `DESC`. With single-order \nsorting, all properties are sorted in the same direction. To sort the results with varying orders by property,\nmultiple sort parameters can be passed.\n \nFor example, the request `/resources?sort=name,ASC&sort=title,DESC` would sort by name ascending and title \ndescending, in that order.\n\n## Search Criteria\n\nUse search criteria to filter the asset set and the vulnerability findings returned for each asset.\n\nSearch criteria supports two independent chunks:\n- `asset` filters which assets are eligible to be returned.\n- `vulnerability` filters which vulnerabilities are returned within each returned asset.\n\nImportant behavior:\n- A `vulnerability` chunk by itself does not change the number of assets returned; it only filters vulnerabilities within those assets.\n- If you want to filter assets using vulnerability characteristics, include those conditions in the `asset` chunk (using `asset.vulnerability.*` mapped fields), not only in the `vulnerability` chunk.\n\nExamples:\n- Filter assets by asset and vulnerability attributes: `{\"asset\": \"os.arch = 'x86_64' && vulnerability.risk > 0.0\"}`\n- Filter vulnerabilities within assets already selected by asset criteria: `{\"asset\": \"last_assessed_for_vulnerabilities >= '2025-09-13T00:02:01Z'\", \"vulnerability\": \"cvss_score >= 9\"}`\n- Vulnerability-only filtering: `{\"vulnerability\": \"cvss_score >= 9\"}`\n\n## Responses\n\nThe following response statuses may be returned by this API.\n   \n| Status | Meaning                  | Usage                                                                                                                                                                    |\n| ------ | ------------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `200`  | OK                       | The operation was performed without error according to the request specification, and no more specific 2xx code is suitable.                                             |\n| `201`  | Created                  | A create request has been fulfilled and a resource has been created. The resource is available as the URI specified in the response, including the `Location` header.    |\n| `202`  | Accepted                 | An asynchronous task has been accepted, but not guaranteed, to be processed in the future.                                                                               |\n| `400`  | Bad Request              | The request was invalid or cannot be otherwise served. The request is not likely to succeed in the future without modifications.                                         |\n| `401`  | Unauthorized             | The user is unauthorized to perform the requested operation, or does not have permission to perform the operation on the specified resource.                             |\n| `403`  | Forbidden                | The resource exists and is accessible to the user, but the requested operation is not permitted.                                                                         |\n| `404`  | Not Found                | The resource specified could not be located, does not exist, or an unauthenticated client does not have permissions to a resource.                                       |\n| `405`  | Method Not Allowed       | The operations may not be performed on the specific resource. Allowed operations are returned and may be performed on the resource.                                      |\n| `408`  | Request Timeout          | The client has failed to complete a request in a timely manner and the request has been discarded.                                                                       |\n| `413`  | Request Entity Too Large | The request being provided is too large for the server to accept processing.                                                                                             |\n| `415`  | Unsupported Media Type   | The media type is not supported for the requested resource.                                                                                                              |\n| `500`  | Internal Server Error    | An internal and unexpected error has occurred on the server at no fault of the client.                                                                                   |\n\n### Errors\n\nError responses can provide a response body with a message to the client indicating more information (if applicable)\nto aid debugging of the error. All 4xx and 5xx responses will return an error response in the body. The format of the \nresponse is as follows:\n\n```json\n{\n   \"status\": <statusCode>,\n   \"message\": <message>,\n   \"localized_message\": <message>,\n   \"links\" : [ {\n      \"rel\" : \"...\",\n      \"href\" : \"...\"\n    } ]\n} \n ```\n \nThe `status` property is the same as the HTTP status returned in the response, to ease client parsing. The `message`\nproperty is a localized message in the request client's locale (if applicable) that articulates the nature of the \nerror. The last property is the `links` property.\n\n### Security\n\nResponse statuses 401, 403, and 404 need special consideration for security purposes. As necessary,\nerror statuses and messages may be obscured to strengthen security and prevent information exposure. The following is a \nguideline for privileged resource response statuses:\n\n| Use Case                                                           | Access             | Resource           | Permission   | Status       |\n| ------------------------------------------------------------------ | ------------------ |------------------- | ------------ | ------------ |\n| Unauthenticated access to an unauthenticated resource.             | Unauthenticated    | Unauthenticated    | Yes          | `20x`        |\n| Unauthenticated access to an authenticated resource.               | Unauthenticated    | Authenticated      | No           | `401`        |\n| Unauthenticated access to an authenticated resource.               | Unauthenticated    | Non-existent       | No           | `401`        |\n| Authenticated access to an unauthenticated resource.               | Authenticated      | Unauthenticated    | Yes          | `20x`        |\n| Authenticated access to an authenticated, unprivileged resource.   | Authenticated      | Authenticated      | No           | `404`        |\n| Authenticated access to an authenticated, privileged resource.     | Authenticated      | Authenticated      | Yes          | `20x`        |\n| Authenticated access to an authenticated, non-existent resource    | Authenticated      | Non-existent       | Yes          | `404`        |\n\n### Headers\n\nCommonly used response headers include:\n\n| Header                     |  Example                          | Purpose                                                         |\n| -------------------------- | --------------------------------- | --------------------------------------------------------------- |\n| `Allow`                    | `OPTIONS, GET`                    | Defines the allowable HTTP operations on a resource.            |\n| `Cache-Control`            | `no-store, must-revalidate`       | Disables caching of resources (as they are all dynamic).        |\n| `Content-Encoding`         | `gzip`                            | The encoding of the response body (if any).                     |\n| `Location`                 |                                   | Refers to the URI of the resource created by a request.         |\n| `Transfer-Encoding`        | `chunked`                         | Specifies the encoding used to transform the response.          |\n| `Retry-After`              | 5000                              | Indicates the time to wait before retrying a request.           |\n| `X-Content-Type-Options`   | `nosniff`                         | Disables MIME type sniffing.                                    |\n| `X-XSS-Protection`         | `1; mode=block`                   | Enables XSS filter protection.                                  |\n| `X-Frame-Options`          | `SAMEORIGIN`                      | Prevents rendering in a frame from a different origin.          |\n| `X-UA-Compatible`          | `IE=edge,chrome=1`                | Specifies the browser mode to render in.                        |\n\n### Format\n\nWhen `application/json` is returned in the response body, it is always pretty-printed (indented, human-readable output).\nAdditionally, gzip compression/encoding is supported on all responses. \n\n#### Dates & Times\n\nDates and times are returned as strings in ISO 8601 \"extended\" format. When a date and time (instant) is returned, the value is converted to UTC.\n\nFor example:\n\n| Value           | Format                         | Example               |\n| --------------- | ------------------------------ | --------------------- |\n| Date            | `YYYY-MM-DD`                   | 2017-12-03            |\n| Date & Time     | `YYYY-MM-DD'T'hh:mm:ss[.nnn]Z` | 2017-12-03T10:15:30Z  |",
    "contact": {
      "name": "Support",
      "email": "support@rapid7.com"
    },
    "license": {
      "name": "Rapid7",
      "url": "https://www.rapid7.com/products/insightvm/"
    },
    "version": "PUBLIC_V4"
  },
  "servers": [
    {
      "url": "https://{region}.api.insight.rapid7.com/vm/",
      "description": "Server"
    }
  ],
  "security": [
    {
      "api-key": []
    }
  ],
  "tags": [
    {
      "name": "Discovery",
      "description": "Endpoints to discover available resources and operations in this API."
    },
    {
      "name": "Asset",
      "description": "Resources and operations for managing assets."
    },
    {
      "name": "Health",
      "description": "Endpoints to monitor service health and quality."
    },
    {
      "name": "Scan",
      "description": "Resources and operations for managing scans."
    },
    {
      "name": "Site",
      "description": "Resources and operations for managing sites."
    },
    {
      "name": "Vulnerability",
      "description": "Resources and operations for viewing vulnerability data."
    }
  ],
  "paths": {
    "/admin/health": {
      "get": {
        "tags": [
          "Health"
        ],
        "summary": "Health Check",
        "description": "Returns an indicator of the health of the API.",
        "operationId": "health",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CompositeHealthSummary"
                },
                "examples": {
                  "application-json": {
                    "summary": "Health",
                    "description": "Healthy service response",
                    "value": {
                      "components": null,
                      "status": "UP",
                      "summary": null
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/assets": {
      "post": {
        "tags": [
          "Asset"
        ],
        "summary": "Search Assets",
        "description": "Returns the inventory, assessment, and summary details for a page of assets. Only assets which the caller has access to are returned. If using the comparisonTime parameter, the recommended page size is 50.",
        "operationId": "searchIntegrationAssets",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "Use the cursor from the previous response to retrieve the next page.",
            "required": false,
            "schema": {
              "example": "<base64-encoded-cursor>"
            }
          },
          {
            "name": "currentTime",
            "in": "query",
            "description": "The current date and time to compare against the asset state to detect changes. If specified, changes in vulnerabilities from this timestamp since the comparison time are calculated and output in the response. If not provided, defaults to the time of request.",
            "required": false,
            "schema": {
              "format": "date-time",
              "example": "2019-04-02T08:17:56.321Z"
            }
          },
          {
            "name": "comparisonTime",
            "in": "query",
            "description": "The date and time to compare the asset current state against to detect changes. If specified, changes in vulnerabilities from this timestamp to the current time are calculated and output in the response. If not provided, defaults to the current time value.",
            "required": false,
            "schema": {
              "format": "date-time",
              "example": "2018-11-09T08:17:56.321Z"
            }
          },
          {
            "name": "includeSame",
            "in": "query",
            "description": "Whether the response should include the list of already-existing vulnerabilities on an asset.",
            "required": false,
            "schema": {
              "example": false,
              "default": false
            }
          },
          {
            "name": "includeUniqueIdentifiers",
            "in": "query",
            "description": "Whether the response should include unique identifiers.",
            "required": false,
            "schema": {
              "example": true,
              "default": true
            }
          },
          {
            "name": "includeInterSnapshotRemediations",
            "in": "query",
            "description": "Whether to include vulnerabilities remediated between comparisonTime and currentTime that are not present in the snapshots.",
            "required": false,
            "schema": {
              "example": true,
              "default": false
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The index of the page (zero-based) to retrieve.",
            "schema": {
              "type": "integer",
              "example": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of records per page to retrieve.",
            "schema": {
              "type": "integer",
              "example": 50
            }
          },
          {
            "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.",
            "schema": {
              "type": "string",
              "format": "<property>[,ASC|DESC]",
              "example": "id,ASC"
            }
          }
        ],
        "requestBody": {
          "description": "Search query for filtering assets and vulnerabilities on assets.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetVulnerabilityQueryResource"
              },
              "examples": {
                "body": {
                  "summary": "Example",
                  "description": "Searching recently scanned assets with critical or severe vulnerabilities.",
                  "value": {
                    "asset": "last_scan_end > 2019-09-04T23:16:57.903Z",
                    "vulnerability": "severity IN ['Critical', 'Severe']"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesAssetSummary"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "data": [
                        {
                          "assessed_for_policies": false,
                          "assessed_for_vulnerabilities": true,
                          "critical_vulnerabilities": 0,
                          "exploits": 0,
                          "id": "452534235-25a7-40a3-9321-28ce0b5cc90e-default-asset-199",
                          "ip": "10.1.0.128",
                          "last_assessed_for_vulnerabilities": "2020-03-20T19:19:42.611Z",
                          "last_scan_end": "2020-03-20T19:19:42.611Z",
                          "last_scan_start": "2020-03-20T19:18:13.611Z",
                          "malware_kits": 0,
                          "moderate_vulnerabilities": 2,
                          "os_architecture": "x86_64",
                          "os_description": "CentOS Linux 2.6.18",
                          "os_family": "Linux",
                          "os_name": "Linux",
                          "os_system_name": "CentOS Linux",
                          "os_type": "General",
                          "os_vendor": "CentOS",
                          "os_version": "2.6.18",
                          "risk_score": 0,
                          "same": [
                            {
                              "check_id": "check_id",
                              "first_found": "2020-03-18T10:46:15Z",
                              "key": "key",
                              "last_found": "2020-03-20T19:18:13.611Z",
                              "nic": "eth0",
                              "port": 2,
                              "proof": "<p>proof</p>",
                              "protocol": "TCP",
                              "reintroduced": null,
                              "solution_fix": "Take a look at all possible solutions for vulnerability",
                              "solution_id": "unknown-acrobat-cve-2018-16015",
                              "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16015",
                              "solution_type": "workaround",
                              "status": "VULNERABLE_POTENTIAL",
                              "vulnerability_id": "acrobat-cve-2018-16015"
                            }
                          ],
                          "severe_vulnerabilities": 0,
                          "tags": [
                            {
                              "name": "lab",
                              "type": "SITE"
                            }
                          ],
                          "total_vulnerabilities": 2,
                          "new": [
                            {
                              "check_id": "check_id",
                              "first_found": "2024-01-25T10:46:15Z",
                              "key": "key-123",
                              "last_found": null,
                              "nic": null,
                              "port": null,
                              "proof": "<p>Proof</p>",
                              "protocol": null,
                              "reintroduced": null,
                              "solution_fix": "Take a look at all possible solutions for vulnerability",
                              "solution_id": "unknown-acrobat-cve-2018-16030",
                              "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16030",
                              "solution_type": "workaround",
                              "status": "VULNERABLE_EXPL",
                              "vulnerability_id": "acrobat-cve-2018-16030"
                            }
                          ],
                          "remediated": [
                            {
                              "check_id": "check_id",
                              "first_found": "2024-01-25T10:46:15Z",
                              "key": "key-456",
                              "last_found": null,
                              "nic": null,
                              "port": null,
                              "proof": "<p>Proof</p>",
                              "protocol": null,
                              "reintroduced": null,
                              "solution_fix": "Take a look at all possible solutions for vulnerability",
                              "solution_id": "unknown-acrobat-cve-2018-16031",
                              "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16031",
                              "solution_type": "workaround",
                              "status": "VULNERABLE_EXPL",
                              "vulnerability_id": "acrobat-cve-2018-16031",
                              "remediation_date": "2024-12-25T00:00:00Z"
                            }
                          ],
                          "unique_identifiers": [
                            {
                              "id": "10.0.0.1",
                              "source": "Endpoint Agent"
                            }
                          ]
                        },
                        {
                          "assessed_for_policies": false,
                          "assessed_for_vulnerabilities": true,
                          "critical_vulnerabilities": 1,
                          "exploits": 9,
                          "host_name": "host.domain.com",
                          "id": "452534235-25a7-40a3-9321-28ce0b5cc90e-default-asset-198",
                          "ip": "10.4.24.164",
                          "last_scan_end": "2020-03-20T19:12:39.766Z",
                          "last_scan_start": "2020-03-20T19:05:06.766Z",
                          "malware_kits": 0,
                          "moderate_vulnerabilities": 11,
                          "os_architecture": "",
                          "os_description": "Ubuntu Linux 12.04",
                          "os_family": "Linux",
                          "os_name": "Linux",
                          "os_system_name": "Ubuntu Linux",
                          "os_type": "",
                          "os_vendor": "Ubuntu",
                          "os_version": "12.04",
                          "risk_score": 12251.76171875,
                          "severe_vulnerabilities": 16,
                          "tags": [
                            {
                              "name": "all_assets2",
                              "type": "CUSTOM"
                            },
                            {
                              "name": "all_assets",
                              "type": "CUSTOM"
                            },
                            {
                              "name": "Linux",
                              "type": "CUSTOM"
                            },
                            {
                              "name": "docker hosts",
                              "type": "SITE"
                            },
                            {
                              "name": "lab",
                              "type": "SITE"
                            }
                          ],
                          "total_vulnerabilities": 28,
                          "new": [
                            {
                              "check_id": "check_id",
                              "first_found": "2024-01-25T10:46:15Z",
                              "key": "key-123",
                              "last_found": null,
                              "nic": null,
                              "port": null,
                              "proof": "<p>Proof</p>",
                              "protocol": null,
                              "reintroduced": null,
                              "solution_fix": "Take a look at all possible solutions for vulnerability",
                              "solution_id": "unknown-acrobat-cve-2018-16030",
                              "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16030",
                              "solution_type": "workaround",
                              "status": "VULNERABLE_EXPL",
                              "vulnerability_id": "acrobat-cve-2018-16030"
                            }
                          ],
                          "remediated": [
                            {
                              "check_id": "check_id",
                              "first_found": "2024-01-25T10:46:15Z",
                              "key": "key-456",
                              "last_found": null,
                              "nic": null,
                              "port": null,
                              "proof": "<p>Proof</p>",
                              "protocol": null,
                              "reintroduced": null,
                              "solution_fix": "Take a look at all possible solutions for vulnerability",
                              "solution_id": "unknown-acrobat-cve-2018-16031",
                              "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16031",
                              "solution_type": "workaround",
                              "status": "VULNERABLE_EXPL",
                              "vulnerability_id": "acrobat-cve-2018-16031",
                              "remediation_date": "2024-12-25T00:00:00Z"
                            }
                          ],
                          "unique_identifiers": {
                            "id": "4421d73dfe04f594df731e6bcd8156a",
                            "source": "R7 Agent"
                          }
                        }
                      ],
                      "metadata": {
                        "number": 0,
                        "size": 2,
                        "totalResources": 2195,
                        "totalPages": 1098,
                        "cursor": "<base64-encoded-cursor>",
                        "effectiveTime": "2024-01-25T00:00:00Z"
                      },
                      "links": [
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=0&size=2",
                          "rel": "first"
                        },
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=0&size=2",
                          "rel": "self"
                        },
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=1&size=2&cursor=<base64-encoded-cursor>",
                          "rel": "next"
                        },
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=1097&size=2",
                          "rel": "last"
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesAssetSummary"
                },
                "examples": {
                  "application-xml": {
                    "summary": "Example (XML)",
                    "description": "A page of assets matching a search filter.",
                    "value": "<PagedResources>\n    <data>\n        <assessed_for_policies>false</assessed_for_policies>\n        <assessed_for_vulnerabilities>true</assessed_for_vulnerabilities>\n        <critical_vulnerabilities>0</critical_vulnerabilities>\n        <exploits>0</exploits>\n        <id>12474375-34a7-40a3-9821-28db0b5cc90e-default-asset-10</id>\n        <ip>10.4.18.61</ip>\n        <last_assessed_for_vulnerabilities>2020-03-20T19:19:42.611Z</last_assessed_for_vulnerabilities>\n        <last_scan_end>2020-03-20T19:19:42.611Z</last_scan_end>\n        <last_scan_start>2020-03-20T19:18:13.611Z</last_scan_start>\n        <malware_kits>0</malware_kits>\n        <moderate_vulnerabilities>2</moderate_vulnerabilities>\n        <os_architecture>x86_64</os_architecture>\n        <os_description>CentOS Linux 2.6.18</os_description>\n        <os_family>Linux</os_family>\n        <os_name>Linux</os_name>\n        <os_system_name>CentOS Linux</os_system_name>\n        <os_type>General</os_type>\n        <os_vendor>CentOS</os_vendor>\n        <os_version>2.6.18</os_version>\n        <risk_score>0.0</risk_score>\n        <severe_vulnerabilities>0</severe_vulnerabilities>\n        <tags>\n            <name>all_assets</name>\n            <type>CUSTOM</type>\n        </tags>\n        <tags>\n            <name>No_Hostname</name>\n            <type>CUSTOM</type>\n        </tags>\n        <tags>\n            <name>Linux</name>\n            <type>CUSTOM</type>\n        </tags>\n        <tags>\n            <name>lab</name>\n            <type>SITE</type>\n        </tags>\n        <total_vulnerabilities>2</total_vulnerabilities>\n    </data>\n    <data>\n        <assessed_for_policies>false</assessed_for_policies>\n        <assessed_for_vulnerabilities>true</assessed_for_vulnerabilities>\n        <critical_vulnerabilities>1</critical_vulnerabilities>\n        <exploits>9</exploits>\n        <host_name>ssl-heartbeat-u.vuln.lax.rapid7.com</host_name>\n        <id>12474375-34a7-40a3-9821-28db0b5cc90e-default-asset-1</id>\n        <ip>10.4.24.164</ip>\n        <last_scan_end>2020-03-20T19:12:39.766Z</last_scan_end>\n        <last_scan_start>2020-03-20T19:05:06.766Z</last_scan_start>\n        <malware_kits>0</malware_kits>\n        <moderate_vulnerabilities>11</moderate_vulnerabilities>\n        <os_architecture></os_architecture>\n        <os_description>Ubuntu Linux 12.04</os_description>\n        <os_family>Linux</os_family>\n        <os_name>Linux</os_name>\n        <os_system_name>Ubuntu Linux</os_system_name>\n        <os_type></os_type>\n        <os_vendor>Ubuntu</os_vendor>\n        <os_version>12.04</os_version>\n        <risk_score>12251.76171875</risk_score>\n        <severe_vulnerabilities>16</severe_vulnerabilities>\n        <tags>\n            <name>all_assets2</name>\n            <type>CUSTOM</type>\n        </tags>\n        <tags>\n            <name>Linux</name>\n            <type>CUSTOM</type>\n        </tags>\n        <tags>\n            <name>all_assets</name>\n            <type>CUSTOM</type>\n        </tags>\n        <tags>\n            <name>docker hosts</name>\n            <type>SITE</type>\n        </tags>\n        <tags>\n            <name>lab</name>\n            <type>SITE</type>\n        </tags>\n        <total_vulnerabilities>28</total_vulnerabilities>\n        <unique_identifiers>\n            <id>4421d73dfe04f594df731e6bcd8156a</id>\n            <source>R7 Agent</source>\n        </unique_identifiers>\n    </data>\n    <metadata>\n        <number>0</number>\n        <size>2</size>\n        <totalResources>2195</totalResources>\n        <totalPages>1098</totalPages>\n        <cursor>1542252837:::_S:::12474375-34a7-40a3-9821-28db0b5cc90e-default-asset-10</cursor>\n    </metadata>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=0&amp;size=2</href>\n        <rel>first</rel>\n    </links>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=0&amp;size=2</href>\n        <rel>self</rel>\n    </links>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=1&amp;size=2&amp;cursor=1542252837:::_S:::12474375-34a7-40a3-9821-28db0b5cc90e-default-asset-10</href>\n        <rel>next</rel>\n    </links>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/assets?page=1097&amp;size=2</href>\n        <rel>last</rel>\n    </links>\n</PagedResources>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/assets/{id}": {
      "get": {
        "tags": [
          "Asset"
        ],
        "summary": "Get Asset",
        "description": "Returns the assessment and details of an asset (specified by id). Only assets which the caller has access to can be returned.",
        "operationId": "getIntegrationAsset",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The identifier of the asset to retrieve the details for.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/AssetKey"
            }
          },
          {
            "name": "currentTime",
            "in": "query",
            "description": "The current date and time to compare the asset state against to detect changes. If specified, changes in vulnerabilities from this timestamp since the comparison time are calculated and output in the response. If not provided, defaults to the time of request.",
            "required": false,
            "schema": {
              "format": "date-time",
              "example": "2019-04-02T08:17:56.321Z"
            }
          },
          {
            "name": "comparisonTime",
            "in": "query",
            "description": "The date and time to compare the current asset state against to detect changes. If specified, changes in vulnerabilities from this timestamp to the current time are calculated and output in the response. If not provided, defaults to the current time value.",
            "required": false,
            "schema": {
              "format": "date-time",
              "example": "2018-11-09T08:17:56.321Z"
            }
          },
          {
            "name": "includeSame",
            "in": "query",
            "description": "Whether the response should include the list of already-existing vulnerabilities on an asset.",
            "required": false,
            "schema": {
              "example": false,
              "default": false
            }
          },
          {
            "name": "includeUniqueIdentifiers",
            "in": "query",
            "description": "Whether the response should include asset unique identifiers in the response.",
            "required": false,
            "schema": {
              "example": true,
              "default": true
            }
          },
          {
            "name": "includeInterSnapshotRemediations",
            "in": "query",
            "description": "Whether to include vulnerabilities remediated between comparisonTime and currentTime that are not present in the snapshots.",
            "required": false,
            "schema": {
              "example": true,
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetSummary"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "The details of an asset.",
                    "value": {
                      "assessed_for_policies": false,
                      "assessed_for_vulnerabilities": true,
                      "critical_vulnerabilities": 16,
                      "exploits": 24,
                      "host_name": "host.domain.com",
                      "id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912",
                      "ip": "10.1.0.128",
                      "last_assessed_for_vulnerabilities": "2019-02-14T21:19:41.090Z",
                      "last_scan_end": "2019-02-14T21:19:41.090Z",
                      "last_scan_start": "2019-02-14T21:05:35.014Z",
                      "mac": "00:50:56:8B:62:45",
                      "malware_kits": 1,
                      "moderate_vulnerabilities": 31,
                      "os_architecture": "",
                      "os_description": "Microsoft Windows Server 2008 R2, Standard Edition SP1",
                      "os_family": "Windows",
                      "os_name": "Windows Server 2008 R2, Standard Edition",
                      "os_system_name": "Microsoft Windows",
                      "os_type": "General",
                      "os_vendor": "Microsoft",
                      "os_version": "SP1",
                      "risk_score": 74621.5625,
                      "same": [
                        {
                          "check_id": "check_id",
                          "first_found": "2020-03-18T10:46:15Z",
                          "key": "key",
                          "last_found": "2020-03-20T19:18:13.611Z",
                          "nic": "eth0",
                          "port": 2,
                          "proof": "<p>proof</p>",
                          "protocol": "TCP",
                          "reintroduced": null,
                          "solution_fix": "Take a look at all possible solutions for vulnerability",
                          "solution_id": "unknown-acrobat-cve-2018-16015",
                          "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16015",
                          "solution_type": "workaround",
                          "status": "VULNERABLE_POTENTIAL",
                          "vulnerability_id": "acrobat-cve-2018-16015"
                        }
                      ],
                      "severe_vulnerabilities": 229,
                      "tags": [
                        {
                          "name": "Windows",
                          "type": "CUSTOM"
                        },
                        {
                          "name": "lab",
                          "type": "SITE"
                        },
                        {
                          "name": "windows targets",
                          "type": "SITE"
                        }
                      ],
                      "total_vulnerabilities": 276,
                      "type": "guest",
                      "new": [
                        {
                          "check_id": "abc",
                          "first_found": "2024-01-25T10:46:15Z",
                          "key": "key-123",
                          "last_found": null,
                          "nic": null,
                          "port": null,
                          "proof": "<p>Generated dummy proof</p>",
                          "protocol": null,
                          "reintroduced": null,
                          "solution_fix": "Take a look at all possible solutions for vulnerability",
                          "solution_id": "unknown-acrobat-cve-2018-16030",
                          "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16030",
                          "solution_type": "workaround",
                          "status": "VULNERABLE_EXPL",
                          "vulnerability_id": "acrobat-cve-2018-16030"
                        }
                      ],
                      "remediated": [
                        {
                          "check_id": "check_id",
                          "first_found": "2024-01-25T10:46:15Z",
                          "key": "key-456",
                          "last_found": null,
                          "nic": null,
                          "port": null,
                          "proof": "<p>Proof</p>",
                          "protocol": null,
                          "reintroduced": null,
                          "solution_fix": "Take a look at all possible solutions for vulnerability",
                          "solution_id": "unknown-acrobat-cve-2018-16031",
                          "solution_summary": "The solution is unknown for vuln acrobat-cve-2018-16031",
                          "solution_type": "workaround",
                          "status": "VULNERABLE_EXPL",
                          "vulnerability_id": "acrobat-cve-2018-16031",
                          "remediation_date": "2024-12-25T00:00:00Z"
                        }
                      ],
                      "unique_identifiers": [
                        {
                          "id": "10.0.0.1",
                          "source": "Endpoint Agent"
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/AssetSummary"
                },
                "examples": {
                  "application-xml": {
                    "summary": "Example",
                    "description": "The details of an asset.",
                    "value": "<AssetSummary>\n    <assessed_for_policies>false</assessed_for_policies>\n    <assessed_for_vulnerabilities>true</assessed_for_vulnerabilities>\n    <critical_vulnerabilities>16</critical_vulnerabilities>\n    <exploits>24</exploits>\n    <host_name>w28s21-ip6-scan.vuln.lax.rapid7.com</host_name>\n    <id>12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912</id>\n    <ip>10.1.0.128</ip>\n    <last_assessed_for_vulnerabilities>2019-02-14T21:19:41.090Z</last_assessed_for_vulnerabilities>\n    <last_scan_end>2019-02-14T21:19:41.090Z</last_scan_end>\n    <last_scan_start>2019-02-14T21:05:35.014Z</last_scan_start>\n    <mac>00:50:56:8B:62:45</mac>\n    <malware_kits>1</malware_kits>\n    <moderate_vulnerabilities>31</moderate_vulnerabilities>\n    <os_architecture></os_architecture>\n    <os_description>Microsoft Windows Server 2008 R2, Standard Edition SP1</os_description>\n    <os_family>Windows</os_family>\n    <os_name>Windows Server 2008 R2, Standard Edition</os_name>\n    <os_system_name>Microsoft Windows</os_system_name>\n    <os_type>General</os_type>\n    <os_vendor>Microsoft</os_vendor>\n    <os_version>SP1</os_version>\n    <risk_score>74621.5625</risk_score>\n    <severe_vulnerabilities>229</severe_vulnerabilities>\n    <tags>\n        <name>Windows</name>\n        <type>CUSTOM</type>\n    </tags>\n    <tags>\n        <name>lab</name>\n        <type>SITE</type>\n    </tags>\n    <tags>\n        <name>windows targets</name>\n        <type>SITE</type>\n    </tags>\n    <total_vulnerabilities>276</total_vulnerabilities>\n    <type>guest</type>\n</AssetSummary>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/scan": {
      "get": {
        "tags": [
          "Scan"
        ],
        "summary": "Get Scans",
        "description": "Retrieves a page of scans.",
        "operationId": "getScans",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "includeDetails",
            "in": "query",
            "description": "Whether the response should include additional details about scans.",
            "required": false,
            "schema": {
              "example": true,
              "default": false
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The index of the page (zero-based) to retrieve.",
            "schema": {
              "type": "integer",
              "example": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of records per page to retrieve.",
            "schema": {
              "type": "integer",
              "example": 50
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesScanResourceWithoutAssetIds"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "A page of scans.",
                    "value": {
                      "data": [
                        {
                          "id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
                          "name": "Scan API Example Name",
                          "engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
                          "status": "Success",
                          "started": "2020-05-12T09:00:12.199Z",
                          "finished": "2020-05-12T09:08:54.404Z"
                        }
                      ],
                      "metadata": {
                        "number": 0,
                        "size": 10,
                        "totalResources": 1,
                        "totalPages": 1
                      },
                      "links": [
                        {
                          "href": "https://{region}.api.insight.rapid7.com:443/vm/v4/integration/scan?page=0&size=10",
                          "rel": "self"
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Scan"
        ],
        "summary": "Start Scan",
        "description": "Starts a scan.",
        "operationId": "startScan",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          }
        ],
        "requestBody": {
          "description": "Input resource for starting a new scan.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScanForm"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DispatchedScansResource"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "The identifier of the newly started scan.",
                    "value": {
                      "scans": [
                        {
                          "id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
                          "engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
                          "name": "Scan API Example Name",
                          "asset_ids": [
                            "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-1",
                            "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-2",
                            "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-3"
                          ]
                        }
                      ],
                      "unscanned_assets": [
                        {
                          "id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-4",
                          "reason": "Asset has never been scanned with an InsightVM Platform registered engine."
                        },
                        {
                          "id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-5",
                          "reason": "Too many assets in request."
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/scan/engine": {
      "get": {
        "tags": [
          "Scan"
        ],
        "summary": "Get Scan Engines",
        "description": "Retrieves a page of scan engines.",
        "operationId": "getScanEngines",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The index of the page (zero-based) to retrieve.",
            "schema": {
              "type": "integer",
              "example": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of records per page to retrieve.",
            "schema": {
              "type": "integer",
              "example": 50
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesScanEngineResource"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "A page of scan engines.",
                    "value": {
                      "data": [
                        {
                          "id": "6c384978-3545-455b-a69a-afa6e8cbd2dd",
                          "host_name": "127.0.0.1",
                          "status": "HEALTHY",
                          "last_seen": "2021-03-02T22:29:05.006Z",
                          "registered": "2020-09-11T18:36:49.973Z",
                          "name": "Scan Engine Example Name",
                          "profile": {
                            "configuration": {
                              "last_retrieved": "2023-08-13T13:23:17.433Z",
                              "properties": [
                                "property1:value1",
                                "property2:value2"
                              ]
                            }
                          }
                        }
                      ],
                      "metadata": {
                        "number": 0,
                        "size": 10,
                        "totalResources": 1,
                        "totalPages": 1
                      },
                      "links": [
                        {
                          "href": "https://{region}.api.insight.rapid7.com:443/vm/v4/integration/scan/engine?page=0&size=10",
                          "rel": "self"
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/scan/engine/{id}": {
      "get": {
        "tags": [
          "Scan"
        ],
        "summary": "Get Scan Engine",
        "description": "Retrieves the scan engine with the specified identifier.",
        "operationId": "getScanEngine",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The identifier of the scan engine to retrieve.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/ScanEngineId"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScanEngineResource"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "Retrieving scan engine with identifier `\"6c384978-3545-455b-a69a-afa6e8cbd2dd\"`.",
                    "value": {
                      "id": "6c384978-3545-455b-a69a-afa6e8cbd2dd",
                      "host_name": "127.0.0.1",
                      "status": "HEALTHY",
                      "last_seen": "2021-03-02T22:29:05.006Z",
                      "registered": "2020-09-11T18:36:49.973Z",
                      "name": "Scan Engine Example Name",
                      "profile": {
                        "configuration": {
                          "last_retrieved": "2023-08-13T13:23:17.433Z",
                          "properties": [
                            "property1:value1",
                            "property2:value2"
                          ]
                        }
                      }
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/scan/engine/{id}/configuration": {
      "post": {
        "tags": [
          "Scan"
        ],
        "summary": "Update Scan Engine Configuration",
        "description": "Updates the custom properties configuration of a scan engine with the specified identifier. May require engine restart before taking effect. Care should be taken when setting custom properties. If you are not familiar with custom properties we recommend contacting Rapid7 Support for assistance.",
        "operationId": "updateScanEngineConfiguration",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The identifier of the scan engine to update.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/ScanEngineId"
            }
          }
        ],
        "requestBody": {
          "description": "A list of key-value pair objects with the custom properties name and parameter values specified.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateEnginePropertiesForm"
              },
              "examples": {
                "body": {
                  "summary": "Example",
                  "description": "Sample request body to update a scan engine configuration properties.",
                  "value": {
                    "properties": [
                      {
                        "name": "com.rapid7.property1",
                        "value": "Example"
                      },
                      {
                        "name": "com.rapid7.property2",
                        "value": "0"
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {},
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "Updating the configuration of the scan engine with identifier `\"6c384978-3545-455b-a69a-afa6e8cbd2dd\"`.",
                    "value": {
                      "message": "A response message"
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Scan"
        ],
        "summary": "Remove Scan Engine Configuration Property",
        "description": "Removes specified custom properties from the configuration of the scan engine with the specified identifier if applied. May require engine restart before taking effect. Care should be taken when setting custom properties. If you are not familiar with custom properties we recommend contacting Rapid7 Support for assistance.",
        "operationId": "removeScanEngineConfiguration",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The identifier of the scan engine to update.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/ScanEngineId"
            }
          }
        ],
        "requestBody": {
          "description": "List of property names to remove from the scan engine configuration.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RemoveScanEngineConfigurationProperty"
              },
              "examples": {
                "body": {
                  "summary": "Example",
                  "description": "Sample request body to remove a scan engine configuration property.",
                  "value": {
                    "properties": [
                      "com.rapid7.exampleProperty1",
                      "com.rapid7.exampleProperty2"
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {},
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "Removing custom properties from the scan engine with identifier `\"6c384978-3545-455b-a69a-afa6e8cbd2dd\"`.",
                    "value": {
                      "message": "A sample message"
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/scan/{id}": {
      "get": {
        "tags": [
          "Scan"
        ],
        "summary": "Get Scan",
        "description": "Retrieves the scan with the specified identifier.",
        "operationId": "getScan",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The identifier of the scan to retrieve.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/ScanId"
            }
          },
          {
            "name": "includeDetails",
            "in": "query",
            "description": "Whether the response should include additional details about the scan.",
            "required": false,
            "schema": {
              "example": true,
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScanResourceWithoutAssetIds"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "Retrieving scan with identifier `\"bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0\"`.",
                    "value": {
                      "id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
                      "name": "Scan API Example Name",
                      "engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
                      "status": "Success",
                      "started": "2020-05-12T09:00:12.199Z",
                      "finished": "2020-05-12T09:08:54.404Z"
                    }
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/scan/{id}/stop": {
      "post": {
        "tags": [
          "Scan"
        ],
        "summary": "Stop Scan",
        "description": "Stops the scan with the specified identifier.",
        "operationId": "stopScan",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "The identifier of the scan to stop.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/ScanId"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted"
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/sites": {
      "post": {
        "tags": [
          "Site"
        ],
        "summary": "List Sites",
        "description": "Returns the details for sites.",
        "operationId": "getSites",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "The stateless cursor to retrieve the next page of resources.",
            "required": false,
            "schema": {
              "example": "<base64-encoded-cursor>"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The index of the page (zero-based) to retrieve.",
            "schema": {
              "type": "integer",
              "example": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of records per page to retrieve.",
            "schema": {
              "type": "integer",
              "example": 50
            }
          },
          {
            "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.",
            "schema": {
              "type": "string",
              "format": "<property>[,ASC|DESC]",
              "example": "id,ASC"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesAssetTagSummary"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "The details for all sites.",
                    "value": {
                      "data": [
                        {
                          "name": "docker hosts",
                          "type": "SITE"
                        },
                        {
                          "name": "lab",
                          "type": "SITE"
                        },
                        {
                          "name": "windows targets",
                          "type": "SITE"
                        }
                      ],
                      "metadata": {
                        "number": 0,
                        "size": 3,
                        "totalResources": 3,
                        "totalPages": 1,
                        "cursor": "-760687744:::_S:::windows targets"
                      },
                      "links": [
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/sites?page=0&size=3",
                          "rel": "self"
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesAssetTagSummary"
                },
                "examples": {
                  "application-xml": {
                    "summary": "Example",
                    "description": "The details for all sites.",
                    "value": "<PagedResources>\n    <data>\n        <name>docker hosts</name>\n        <type>SITE</type>\n    </data>\n    <data>\n        <name>lab</name>\n        <type>SITE</type>\n    </data>\n    <data>\n        <name>windows targets</name>\n        <type>SITE</type>\n    </data>\n    <metadata>\n        <number>0</number>\n        <size>3</size>\n        <totalResources>3</totalResources>\n        <totalPages>1</totalPages>\n        <cursor>-760687744:::_S:::windows targets</cursor>\n    </metadata>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/sites?page=0&amp;size=3</href>\n        <rel>self</rel>\n    </links>\n</PagedResources>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    },
    "/v4/integration/vulnerabilities": {
      "post": {
        "tags": [
          "Vulnerability"
        ],
        "summary": "Search Vulnerabilities",
        "description": "Returns all vulnerabilities that can be assessed.",
        "operationId": "searchIntegrationVulnerabilities",
        "parameters": [
          {
            "name": "region",
            "in": "path",
            "description": "The region of the Insight Platform to use. See [Overview](#section/Overview) for more information.",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "The stateless cursor to retrieve the next page of resources.",
            "required": false,
            "schema": {
              "example": "<base64-encoded-cursor>"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The index of the page (zero-based) to retrieve.",
            "schema": {
              "type": "integer",
              "example": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of records per page to retrieve.",
            "schema": {
              "type": "integer",
              "example": 50
            }
          },
          {
            "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.",
            "schema": {
              "type": "string",
              "format": "<property>[,ASC|DESC]",
              "example": "id,ASC"
            }
          }
        ],
        "requestBody": {
          "description": "Search criteria for finding vulnerabilities.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VulnerabilitySearch"
              },
              "examples": {
                "body": {
                  "summary": "Example",
                  "description": "Searching vulnerabilities by last modified date.",
                  "value": {
                    "vulnerability": "modified > 2020-01-01T00:00:00Z"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "SUCCESS",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesVulnerabilitySummary"
                },
                "examples": {
                  "application-json": {
                    "summary": "Example",
                    "description": "Retrieving a page of vulnerabilities by last modified date.",
                    "value": {
                      "data": [
                        {
                          "added": "2018-05-16T00:00:00Z",
                          "categories": "7-Zip",
                          "cves": "CVE-2008-6536",
                          "cvss_v2_access_complexity": "low",
                          "cvss_v2_access_vector": "network",
                          "cvss_v2_authentication": "none",
                          "cvss_v2_availability_impact": "complete",
                          "cvss_v2_confidentiality_impact": "complete",
                          "cvss_v2_exploit_score": 9.996799,
                          "cvss_v2_impact_score": 10.000845,
                          "cvss_v2_integrity_impact": "complete",
                          "cvss_v2_score": 10,
                          "cvss_v2_vector": "AV:N/AC:L/Au:N/C:C/I:C/A:C",
                          "cvss_v3_attack_complexity": null,
                          "cvss_v3_attack_vector": null,
                          "cvss_v3_availability_impact": null,
                          "cvss_v3_confidentiality_impact": null,
                          "cvss_v3_exploit_score": 0,
                          "cvss_v3_impact_score": 0,
                          "cvss_v3_integrity_impact": null,
                          "cvss_v3_privileges_required": null,
                          "cvss_v3_scope": null,
                          "cvss_v3_score": 0,
                          "cvss_v3_user_interaction": null,
                          "cvss_v3_vector": null,
                          "denial_of_service": false,
                          "description": "Unspecified vulnerability in 7-zip before 4.5.7 has unknown impact and remote attack vectors, as demonstrated by the PROTOS GENOME test suite for Archive Formats (c10).",
                          "exploits": [],
                          "id": "7-zip-cve-2008-6536",
                          "links": [
                            {
                              "href": "http://www.securityfocus.com/bid/28285",
                              "id": "28285",
                              "rel": "advisory",
                              "source": "bid"
                            },
                            {
                              "href": "https://exchange.xforce.ibmcloud.com/vulnerabilities/41247",
                              "id": "41247",
                              "rel": "advisory",
                              "source": "xf"
                            },
                            {
                              "href": "http://nvd.nist.gov/vuln/detail/CVE-2008-6536",
                              "id": "CVE-2008-6536",
                              "rel": "advisory",
                              "source": "cve"
                            },
                            {
                              "href": "http://www.cert.fi/haavoittuvuudet/joint-advisory-archive-formats.html",
                              "id": "http://www.cert.fi/haavoittuvuudet/joint-advisory-archive-formats.html",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.ee.oulu.fi/research/ouspg/protos/testing/c10/archive/",
                              "id": "http://www.ee.oulu.fi/research/ouspg/protos/testing/c10/archive/",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.securityfocus.com/bid/28285",
                              "id": "http://www.securityfocus.com/bid/28285",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.vupen.com/english/advisories/2008/0914/references",
                              "id": "http://www.vupen.com/english/advisories/2008/0914/references",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.xerox.com/download/security/security-bulletin/16287-4d6b7b0c81f7b/cert_XRX13-003_v1.0.pdf",
                              "id": "http://www.xerox.com/download/security/security-bulletin/16287-4d6b7b0c81f7b/cert_XRX13-003_v1.0.pdf",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "https://exchange.xforce.ibmcloud.com/vulnerabilities/41247",
                              "id": "https://exchange.xforce.ibmcloud.com/vulnerabilities/41247",
                              "rel": "advisory",
                              "source": "url"
                            }
                          ],
                          "malware_kits": [],
                          "modified": "2018-06-08T00:00:00Z",
                          "pci_cvss_score": 10,
                          "pci_fail": true,
                          "pci_severity_score": 5,
                          "pci_special_notes": "",
                          "pci_status": "fail",
                          "published": "2009-03-29T00:00:00Z",
                          "references": "bid:28285,xf:41247,cve:CVE-2008-6536,url:http://www.cert.fi/haavoittuvuudet/joint-advisory-archive-formats.html,url:http://www.ee.oulu.fi/research/ouspg/protos/testing/c10/archive/,url:http://www.securityfocus.com/bid/28285,url:http://www.vupen.com/english/advisories/2008/0914/references,url:http://www.xerox.com/download/security/security-bulletin/16287-4d6b7b0c81f7b/cert_XRX13-003_v1.0.pdf,url:https://exchange.xforce.ibmcloud.com/vulnerabilities/41247",
                          "risk_score": 885.16,
                          "severity": "critical",
                          "severity_score": 10,
                          "title": "7-Zip: CVE-2008-6536: Unspecified vulnerability in 7-zip before 4.5.7"
                        },
                        {
                          "added": "2018-05-16T00:00:00Z",
                          "categories": "7-Zip,Remote Execution",
                          "cves": "CVE-2016-2334",
                          "cvss_v2_access_complexity": "medium",
                          "cvss_v2_access_vector": "network",
                          "cvss_v2_authentication": "none",
                          "cvss_v2_availability_impact": "complete",
                          "cvss_v2_confidentiality_impact": "complete",
                          "cvss_v2_exploit_score": 8.5888,
                          "cvss_v2_impact_score": 10.000845,
                          "cvss_v2_integrity_impact": "complete",
                          "cvss_v2_score": 9.3,
                          "cvss_v2_vector": "AV:N/AC:M/Au:N/C:C/I:C/A:C",
                          "cvss_v3_attack_complexity": "low",
                          "cvss_v3_attack_vector": "local",
                          "cvss_v3_availability_impact": "high",
                          "cvss_v3_confidentiality_impact": "high",
                          "cvss_v3_exploit_score": 1.8345766,
                          "cvss_v3_impact_score": 5.873119,
                          "cvss_v3_integrity_impact": "high",
                          "cvss_v3_privileges_required": "none",
                          "cvss_v3_scope": "unchanged",
                          "cvss_v3_score": 7.8,
                          "cvss_v3_user_interaction": "required",
                          "cvss_v3_vector": "CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H",
                          "denial_of_service": false,
                          "description": "Heap-based buffer overflow in the NArchive::NHfs::CHandler::ExtractZlibFile method in 7zip before 16.00 and p7zip allows remote attackers to execute arbitrary code via a crafted HFS+ image.",
                          "exploits": [],
                          "id": "7-zip-cve-2016-2334",
                          "links": [
                            {
                              "href": "http://www.securityfocus.com/bid/90531",
                              "id": "90531",
                              "rel": "advisory",
                              "source": "bid"
                            },
                            {
                              "href": "http://nvd.nist.gov/vuln/detail/CVE-2016-2334",
                              "id": "CVE-2016-2334",
                              "rel": "advisory",
                              "source": "cve"
                            },
                            {
                              "href": "http://blog.talosintel.com/2016/05/multiple-7-zip-vulnerabilities.html",
                              "id": "http://blog.talosintel.com/2016/05/multiple-7-zip-vulnerabilities.html",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://blog.talosintelligence.com/2017/11/exploiting-cve-2016-2334.html",
                              "id": "http://blog.talosintelligence.com/2017/11/exploiting-cve-2016-2334.html",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.oracle.com/technetwork/topics/security/bulletinoct2016-3090566.html",
                              "id": "http://www.oracle.com/technetwork/topics/security/bulletinoct2016-3090566.html",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.securityfocus.com/bid/90531",
                              "id": "http://www.securityfocus.com/bid/90531",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.securitytracker.com/id/1035876",
                              "id": "http://www.securitytracker.com/id/1035876",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "http://www.talosintel.com/reports/TALOS-2016-0093/",
                              "id": "http://www.talosintel.com/reports/TALOS-2016-0093/",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DNYIQAU3FKFBNFPK6GKYTSVRHQA7PTYT/",
                              "id": "https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DNYIQAU3FKFBNFPK6GKYTSVRHQA7PTYT/",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DTGWICT3KYYDPDXRNO5SXD32GZICGRIR/",
                              "id": "https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DTGWICT3KYYDPDXRNO5SXD32GZICGRIR/",
                              "rel": "advisory",
                              "source": "url"
                            },
                            {
                              "href": "https://security.gentoo.org/glsa/201701-27",
                              "id": "https://security.gentoo.org/glsa/201701-27",
                              "rel": "advisory",
                              "source": "url"
                            }
                          ],
                          "malware_kits": [],
                          "modified": "2018-06-08T00:00:00Z",
                          "pci_cvss_score": 9.3,
                          "pci_fail": true,
                          "pci_severity_score": 5,
                          "pci_special_notes": "",
                          "pci_status": "fail",
                          "published": "2016-12-13T00:00:00Z",
                          "references": "bid:90531,cve:CVE-2016-2334,url:http://blog.talosintel.com/2016/05/multiple-7-zip-vulnerabilities.html,url:http://blog.talosintelligence.com/2017/11/exploiting-cve-2016-2334.html,url:http://www.oracle.com/technetwork/topics/security/bulletinoct2016-3090566.html,url:http://www.securityfocus.com/bid/90531,url:http://www.securitytracker.com/id/1035876,url:http://www.talosintel.com/reports/TALOS-2016-0093/,url:https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DNYIQAU3FKFBNFPK6GKYTSVRHQA7PTYT/,url:https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DTGWICT3KYYDPDXRNO5SXD32GZICGRIR/,url:https://security.gentoo.org/glsa/201701-27",
                          "risk_score": 582.82,
                          "severity": "critical",
                          "severity_score": 9,
                          "title": "7-Zip: CVE-2016-2334: Heap-based buffer overflow vulnerability"
                        }
                      ],
                      "metadata": {
                        "number": 0,
                        "size": 2,
                        "totalResources": 81631,
                        "totalPages": 40816,
                        "cursor": "-37745434:::_S:::7-zip-cve-2016-2334"
                      },
                      "links": [
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=0&size=2&sort=id,asc",
                          "rel": "first"
                        },
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=0&size=2&sort=id,asc",
                          "rel": "self"
                        },
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=1&size=2&sort=id,asc&cursor=-37745434:::_S:::7-zip-cve-2016-2334",
                          "rel": "next"
                        },
                        {
                          "href": "https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=40815&size=2&sort=id,asc",
                          "rel": "last"
                        }
                      ]
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResourcesVulnerabilitySummary"
                },
                "examples": {
                  "application-xml": {
                    "summary": "Example",
                    "description": "Retrieving a page of vulnerabilities by last modified date.",
                    "value": "<PagedResources>\n    <data>\n        <added>2018-05-16T00:00:00Z</added>\n        <categories>7-Zip</categories>\n        <cves>CVE-2008-6536</cves>\n        <cvss_v2_access_complexity>low</cvss_v2_access_complexity>\n        <cvss_v2_access_vector>network</cvss_v2_access_vector>\n        <cvss_v2_authentication>none</cvss_v2_authentication>\n        <cvss_v2_availability_impact>complete</cvss_v2_availability_impact>\n        <cvss_v2_confidentiality_impact>complete</cvss_v2_confidentiality_impact>\n        <cvss_v2_exploit_score>9.996799</cvss_v2_exploit_score>\n        <cvss_v2_impact_score>10.000845</cvss_v2_impact_score>\n        <cvss_v2_integrity_impact>complete</cvss_v2_integrity_impact>\n        <cvss_v2_score>10.0</cvss_v2_score>\n        <cvss_v2_vector>AV:N/AC:L/Au:N/C:C/I:C/A:C</cvss_v2_vector>\n        <cvss_v3_attack_complexity/>\n        <cvss_v3_attack_vector/>\n        <cvss_v3_availability_impact/>\n        <cvss_v3_confidentiality_impact/>\n        <cvss_v3_exploit_score>0.0</cvss_v3_exploit_score>\n        <cvss_v3_impact_score>0.0</cvss_v3_impact_score>\n        <cvss_v3_integrity_impact/>\n        <cvss_v3_privileges_required/>\n        <cvss_v3_scope/>\n        <cvss_v3_score>0.0</cvss_v3_score>\n        <cvss_v3_user_interaction/>\n        <cvss_v3_vector/>\n        <denial_of_service>false</denial_of_service>\n        <description>Unspecified vulnerability in 7-zip before 4.5.7 has unknown impact and remote attack vectors, as demonstrated by the PROTOS GENOME test suite for Archive Formats (c10).</description>\n        <id>7-zip-cve-2008-6536</id>\n        <links>\n            <href>http://www.securityfocus.com/bid/28285</href>\n            <id>28285</id>\n            <rel>advisory</rel>\n            <source>bid</source>\n        </links>\n        <links>\n            <href>https://exchange.xforce.ibmcloud.com/vulnerabilities/41247</href>\n            <id>41247</id>\n            <rel>advisory</rel>\n            <source>xf</source>\n        </links>\n        <links>\n            <href>http://nvd.nist.gov/vuln/detail/CVE-2008-6536</href>\n            <id>CVE-2008-6536</id>\n            <rel>advisory</rel>\n            <source>cve</source>\n        </links>\n        <links>\n            <href>http://www.cert.fi/haavoittuvuudet/joint-advisory-archive-formats.html</href>\n            <id>http://www.cert.fi/haavoittuvuudet/joint-advisory-archive-formats.html</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.ee.oulu.fi/research/ouspg/protos/testing/c10/archive/</href>\n            <id>http://www.ee.oulu.fi/research/ouspg/protos/testing/c10/archive/</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.securityfocus.com/bid/28285</href>\n            <id>http://www.securityfocus.com/bid/28285</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.vupen.com/english/advisories/2008/0914/references</href>\n            <id>http://www.vupen.com/english/advisories/2008/0914/references</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.xerox.com/download/security/security-bulletin/16287-4d6b7b0c81f7b/cert_XRX13-003_v1.0.pdf</href>\n            <id>http://www.xerox.com/download/security/security-bulletin/16287-4d6b7b0c81f7b/cert_XRX13-003_v1.0.pdf</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>https://exchange.xforce.ibmcloud.com/vulnerabilities/41247</href>\n            <id>https://exchange.xforce.ibmcloud.com/vulnerabilities/41247</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <modified>2018-06-08T00:00:00Z</modified>\n        <pci_cvss_score>10.0</pci_cvss_score>\n        <pci_fail>true</pci_fail>\n        <pci_severity_score>5</pci_severity_score>\n        <pci_special_notes></pci_special_notes>\n        <pci_status>fail</pci_status>\n        <published>2009-03-29T00:00:00Z</published>\n        <references>bid:28285,xf:41247,cve:CVE-2008-6536,url:http://www.cert.fi/haavoittuvuudet/joint-advisory-archive-formats.html,url:http://www.ee.oulu.fi/research/ouspg/protos/testing/c10/archive/,url:http://www.securityfocus.com/bid/28285,url:http://www.vupen.com/english/advisories/2008/0914/references,url:http://www.xerox.com/download/security/security-bulletin/16287-4d6b7b0c81f7b/cert_XRX13-003_v1.0.pdf,url:https://exchange.xforce.ibmcloud.com/vulnerabilities/41247</references>\n        <risk_score>885.16</risk_score>\n        <severity>critical</severity>\n        <severity_score>10</severity_score>\n        <title>7-Zip: CVE-2008-6536: Unspecified vulnerability in 7-zip before 4.5.7</title>\n    </data>\n    <data>\n        <added>2018-05-16T00:00:00Z</added>\n        <categories>7-Zip,Remote Execution</categories>\n        <cves>CVE-2016-2334</cves>\n        <cvss_v2_access_complexity>medium</cvss_v2_access_complexity>\n        <cvss_v2_access_vector>network</cvss_v2_access_vector>\n        <cvss_v2_authentication>none</cvss_v2_authentication>\n        <cvss_v2_availability_impact>complete</cvss_v2_availability_impact>\n        <cvss_v2_confidentiality_impact>complete</cvss_v2_confidentiality_impact>\n        <cvss_v2_exploit_score>8.5888</cvss_v2_exploit_score>\n        <cvss_v2_impact_score>10.000845</cvss_v2_impact_score>\n        <cvss_v2_integrity_impact>complete</cvss_v2_integrity_impact>\n        <cvss_v2_score>9.3</cvss_v2_score>\n        <cvss_v2_vector>AV:N/AC:M/Au:N/C:C/I:C/A:C</cvss_v2_vector>\n        <cvss_v3_attack_complexity>low</cvss_v3_attack_complexity>\n        <cvss_v3_attack_vector>local</cvss_v3_attack_vector>\n        <cvss_v3_availability_impact>high</cvss_v3_availability_impact>\n        <cvss_v3_confidentiality_impact>high</cvss_v3_confidentiality_impact>\n        <cvss_v3_exploit_score>1.8345766</cvss_v3_exploit_score>\n        <cvss_v3_impact_score>5.873119</cvss_v3_impact_score>\n        <cvss_v3_integrity_impact>high</cvss_v3_integrity_impact>\n        <cvss_v3_privileges_required>none</cvss_v3_privileges_required>\n        <cvss_v3_scope>unchanged</cvss_v3_scope>\n        <cvss_v3_score>7.8</cvss_v3_score>\n        <cvss_v3_user_interaction>required</cvss_v3_user_interaction>\n        <cvss_v3_vector>CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H</cvss_v3_vector>\n        <denial_of_service>false</denial_of_service>\n        <description>Heap-based buffer overflow in the NArchive::NHfs::CHandler::ExtractZlibFile method in 7zip before 16.00 and p7zip allows remote attackers to execute arbitrary code via a crafted HFS+ image.</description>\n        <id>7-zip-cve-2016-2334</id>\n        <links>\n            <href>http://www.securityfocus.com/bid/90531</href>\n            <id>90531</id>\n            <rel>advisory</rel>\n            <source>bid</source>\n        </links>\n        <links>\n            <href>http://nvd.nist.gov/vuln/detail/CVE-2016-2334</href>\n            <id>CVE-2016-2334</id>\n            <rel>advisory</rel>\n            <source>cve</source>\n        </links>\n        <links>\n            <href>http://blog.talosintel.com/2016/05/multiple-7-zip-vulnerabilities.html</href>\n            <id>http://blog.talosintel.com/2016/05/multiple-7-zip-vulnerabilities.html</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://blog.talosintelligence.com/2017/11/exploiting-cve-2016-2334.html</href>\n            <id>http://blog.talosintelligence.com/2017/11/exploiting-cve-2016-2334.html</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.oracle.com/technetwork/topics/security/bulletinoct2016-3090566.html</href>\n            <id>http://www.oracle.com/technetwork/topics/security/bulletinoct2016-3090566.html</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.securityfocus.com/bid/90531</href>\n            <id>http://www.securityfocus.com/bid/90531</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.securitytracker.com/id/1035876</href>\n            <id>http://www.securitytracker.com/id/1035876</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>http://www.talosintel.com/reports/TALOS-2016-0093/</href>\n            <id>http://www.talosintel.com/reports/TALOS-2016-0093/</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DNYIQAU3FKFBNFPK6GKYTSVRHQA7PTYT/</href>\n            <id>https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DNYIQAU3FKFBNFPK6GKYTSVRHQA7PTYT/</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DTGWICT3KYYDPDXRNO5SXD32GZICGRIR/</href>\n            <id>https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DTGWICT3KYYDPDXRNO5SXD32GZICGRIR/</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <links>\n            <href>https://security.gentoo.org/glsa/201701-27</href>\n            <id>https://security.gentoo.org/glsa/201701-27</id>\n            <rel>advisory</rel>\n            <source>url</source>\n        </links>\n        <modified>2018-06-08T00:00:00Z</modified>\n        <pci_cvss_score>9.3</pci_cvss_score>\n        <pci_fail>true</pci_fail>\n        <pci_severity_score>5</pci_severity_score>\n        <pci_special_notes></pci_special_notes>\n        <pci_status>fail</pci_status>\n        <published>2016-12-13T00:00:00Z</published>\n        <references>bid:90531,cve:CVE-2016-2334,url:http://blog.talosintel.com/2016/05/multiple-7-zip-vulnerabilities.html,url:http://blog.talosintelligence.com/2017/11/exploiting-cve-2016-2334.html,url:http://www.oracle.com/technetwork/topics/security/bulletinoct2016-3090566.html,url:http://www.securityfocus.com/bid/90531,url:http://www.securitytracker.com/id/1035876,url:http://www.talosintel.com/reports/TALOS-2016-0093/,url:https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DNYIQAU3FKFBNFPK6GKYTSVRHQA7PTYT/,url:https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/DTGWICT3KYYDPDXRNO5SXD32GZICGRIR/,url:https://security.gentoo.org/glsa/201701-27</references>\n        <risk_score>582.82</risk_score>\n        <severity>critical</severity>\n        <severity_score>9</severity_score>\n        <title>7-Zip: CVE-2016-2334: Heap-based buffer overflow vulnerability</title>\n    </data>\n    <metadata>\n        <number>0</number>\n        <size>2</size>\n        <totalResources>81631</totalResources>\n        <totalPages>40816</totalPages>\n        <cursor>-37745434:::_S:::7-zip-cve-2016-2334</cursor>\n    </metadata>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=0&amp;size=2&amp;sort=id,asc</href>\n        <rel>first</rel>\n    </links>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=0&amp;size=2&amp;sort=id,asc</href>\n        <rel>self</rel>\n    </links>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=1&amp;size=2&amp;sort=id,asc&amp;cursor=-37745434:::_S:::7-zip-cve-2016-2334</href>\n        <rel>next</rel>\n    </links>\n    <links>\n        <href>https://us.api.insight.rapid7.com:443/vm/v4/integration/vulnerabilities?page=40815&amp;size=2&amp;sort=id,asc</href>\n        <rel>last</rel>\n    </links>\n</PagedResources>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "400": {
            "description": "BAD REQUEST",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": {
                      "status": 400,
                      "localized_message": "A request body must be provided.",
                      "message": "Required request body is missing."
                    }
                  },
                  "application-json": {
                    "summary": "Example (JSON)",
                    "description": "A page of assets matching a search filter.",
                    "value": {
                      "status": 400,
                      "message": "Invalid cursor. Use the value returned in metadata.cursor from a previous response.",
                      "links": []
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Bad Request",
                    "description": "Example response with a Bad Request (400) status.",
                    "value": "<ErrorResource>\n   <status>400</status>\n   <message>Required request body is missing.</message>\n   <localizedMessage>A request body must be provided.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "401": {
            "description": "UNAUTHORIZED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": {
                      "status": 401,
                      "localized_message": "Authorization is required to interact with this resource.",
                      "message": "Full authentication is required to access this resource."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unauthorized",
                    "description": "Example response with an Unauthorized (401) status.",
                    "value": "<ErrorResource>\n  <status>401</status>\n  <localizedMessage>Authorization is required to interact with this resource.</localizedMessage>\n  <message>Full authentication is required to access this resource.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "404": {
            "description": "NOT FOUND",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": {
                      "status": 404,
                      "localized_message": "The requested resource does not exist.",
                      "message": "The resource does not exist."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Not Found",
                    "description": "Example response with a Not Found (404) status.",
                    "value": "<ErrorResource>\n  <status>404</status>\n  <localizedMessage>The requested resource does not exist.</localizedMessage>\n  <message>The resource does not exist.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "415": {
            "description": "UNSUPPORTED MEDIA TYPE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": null
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Unsupported Media Type",
                    "description": "Example response with an Unsupported Media Type (415) status. Responses will empty as no suitable representation for the output content type could be negotiated.",
                    "value": " "
                  }
                },
                "encoding": {}
              }
            }
          },
          "500": {
            "description": "INTERNAL SERVER ERROR",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": {
                      "status": 500,
                      "localized_message": "An unexpected error occurred. Please contact Rapid7 support.",
                      "message": "An unexpected error occurred. Please contact Rapid7 support."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Internal Server Error",
                    "description": "Example response with an Internal Server Error (500) status.",
                    "value": "<ErrorResource>\n  <status>500</status>\n  <message>An unexpected error occurred. Please contact Rapid7 support.</message>\n  <localizedMessage>An unexpected error occurred. Please contact Rapid7 support.</localizedMessage>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          },
          "503": {
            "description": "SERVICE UNAVAILABLE",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "json": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": {
                      "status": 503,
                      "localized_message": "The service is not currently available. Please try again.",
                      "message": "Service unavailable."
                    }
                  }
                },
                "encoding": {}
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "xml": {
                    "summary": "Service Unavailable",
                    "description": "Example response with a Service Unavailable (503) status.",
                    "value": "<ErrorResource>\n  <status>503</status>\n  <localizedMessage>The service is not currently available. Please try again.\"</localizedMessage>\n  <message>Service unavailable.</message>\n</ErrorResource>"
                  }
                },
                "encoding": {}
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AssetVulnerabilityQueryResource": {
        "title": "${asset.vulnerability.query.resource.title}, ${assetvulnerabilityqueryresource.title}",
        "properties": {
          "asset": {
            "description": "Example <code>{\"asset\": \"last_scan_end >= '2025-09-13T00:02:01Z' && cvss_score >= 9\"}</code> Filter for assets that have vulnerabilities matching the asset criteria."
          },
          "vulnerability": {
            "description": "Example <code>{\"asset\": \"last_assessed_for_vulnerabilities >= '2025-09-13T00:02:01Z'\", \"vulnerability\": \"cvss_score >= 9\"}</code> Filter the results to include assets which have vulnerabilities matching the asset criteria and subsequently filter for individual vulnerabilities that meet the vulnerability criteria."
          }
        },
        "description": "${assetvulnerabilityqueryresource.description}, ${asset.vulnerability.query.resource.description}"
      },
      "AssetKey": {
        "title": "${assetkey.title}, ${asset.key.title}",
        "properties": {
          "id": {
            "description": "${assetkey.id.description}, ${asset.key.id.description}"
          }
        },
        "description": "${asset.key.description}, ${assetkey.description}"
      },
      "AssetSummary": {
        "title": "${assetsummary.title}, ${asset.summary.title}",
        "properties": {
          "assessed_for_policies": {
            "description": "Whether an asset was assessed for policies."
          },
          "assessed_for_vulnerabilities": {
            "description": "Whether an asset was assessed for vulnerabilities."
          },
          "credential_assessments": {
            "description": "The credential assessments for the asset.",
            "items": {
              "$ref": "#/components/schemas/CredentialAssessmentSummary"
            }
          },
          "critical_vulnerabilities": {
            "description": "The count of critical vulnerability findings.",
            "format": "int32"
          },
          "exploits": {
            "description": "The count of known unique exploits that can be used to exploit vulnerabilities on the asset.",
            "format": "int32"
          },
          "host_name": {
            "description": "The host name (local or FQDN)."
          },
          "id": {
            "$ref": "#/components/schemas/AssetKey"
          },
          "ip": {
            "description": "The IPv4 or IPv6 address."
          },
          "last_assessed_for_vulnerabilities": {
            "description": "The time at which an asset was assessed for vulnerabilities.",
            "format": "date-time"
          },
          "last_scan_end": {
            "description": "The time at which the last scan of the asset ended.",
            "format": "date-time"
          },
          "last_scan_start": {
            "description": "The time at which the last scan of the asset started.",
            "format": "date-time"
          },
          "mac": {
            "description": "The Media Access Control (MAC) address. The format is six groups of two hexadecimal digits separated by colons."
          },
          "malware_kits": {
            "description": "The count of known unique malware kits that can be used to attack vulnerabilities on the asset.",
            "format": "int32"
          },
          "moderate_vulnerabilities": {
            "description": "The count of moderate vulnerability findings.",
            "format": "int32"
          },
          "new": {
            "description": "If a comparison time is supplied, the vulnerabilities that are the new in the latest version at current time.",
            "items": {
              "$ref": "#/components/schemas/AssetVulnerabilityResultSummary"
            }
          },
          "os_architecture": {
            "description": "The architecture of the operating system."
          },
          "os_description": {
            "description": "The description of the operating system (containing vendor, family, product, version and architecture in a single string)."
          },
          "os_family": {
            "description": "The family of the operating system."
          },
          "os_name": {
            "description": "The name of the operating system."
          },
          "os_system_name": {
            "description": "A combination of vendor and family (with redundancies removed), suitable for grouping."
          },
          "os_type": {
            "description": "The type of operating system."
          },
          "os_vendor": {
            "description": "The vendor of the operating system."
          },
          "os_version": {
            "description": "The version of the operating system."
          },
          "remediated": {
            "description": "If a comparison time is supplied, the vulnerabilities that were remediated in the latest version at current time.",
            "items": {
              "$ref": "#/components/schemas/AssetVulnerabilityResultSummary"
            }
          },
          "risk_score": {
            "description": "The risk score (with criticality adjustments) of the asset.",
            "format": "double"
          },
          "same": {
            "description": "If a comparison time is supplied and includeSame is `true`, the vulnerabilities that are the same between current and comparison time.",
            "items": {
              "$ref": "#/components/schemas/AssetVulnerabilityResultSummary"
            }
          },
          "severe_vulnerabilities": {
            "description": "The count of severe vulnerability findings.",
            "format": "int32"
          },
          "tags": {
            "description": "The tags applied to the asset.",
            "items": {
              "$ref": "#/components/schemas/AssetTagSummary"
            }
          },
          "total_vulnerabilities": {
            "description": "The total count of vulnerability findings.",
            "format": "int32"
          },
          "type": {
            "description": "The type of asset.",
            "enum": [
              "unknown",
              "guest",
              "hypervisor",
              "physical",
              "mobile"
            ]
          },
          "unique_identifiers": {
            "description": "Unique identifiers found on the asset, such as hardware or operating system identifiers.",
            "items": {
              "$ref": "#/components/schemas/UniqueIdSummary"
            }
          }
        },
        "description": "${assetsummary.description}, ${asset.summary.description}"
      },
      "DispatchedScansResource": {
        "title": "${dispatchedscansresource.title}, ${dispatched.scans.resource.title}",
        "properties": {
          "scans": {
            "description": "${dispatched.scans.resource.scans.description}, ${dispatchedscansresource.scans.description}",
            "items": {
              "$ref": "#/components/schemas/ScanResource"
            }
          },
          "unscanned_assets": {
            "description": "${dispatchedscansresource.unscanned.assets.description}, ${dispatched.scans.resource.unscanned_assets.description}, ${dispatchedscansresource.unscanned_assets.description}, ${dispatched.scans.resource.unscanned.assets.description}",
            "items": {
              "$ref": "#/components/schemas/UnscannedAssetResource"
            }
          }
        },
        "description": "${dispatchedscansresource.description}, ${dispatched.scans.resource.description}"
      },
      "Endpoint": {
        "title": "${endpoint.title}",
        "properties": {
          "port": {
            "description": "${endpoint.port.description}",
            "format": "int64"
          },
          "protocol": {
            "description": "${endpoint.protocol.description}",
            "enum": [
              "IP",
              "ICMP",
              "IGMP",
              "GGP",
              "TCP",
              "PUP",
              "UDP",
              "IDP",
              "ESP",
              "ND",
              "RAW"
            ]
          }
        },
        "description": "${endpoint.description}"
      },
      "EntityType": {
        "title": "${entitytype.title}, ${entity.type.title}",
        "properties": {
          "entity": {
            "description": "${entity.type.entity.description}, ${entitytype.entity.description}"
          }
        },
        "description": "${entitytype.description}, ${entity.type.description}"
      },
      "MalwareKitId": {
        "title": "${malwarekitid.title}, ${malware.kit.id.title}",
        "properties": {
          "entityType": {
            "$ref": "#/components/schemas/EntityType"
          },
          "id": {
            "description": "${malware.kit.id.id.description}, ${malwarekitid.id.description}"
          }
        },
        "description": "The identifier of the malware kit."
      },
      "PagedResourcesAssetSummary": {
        "title": "${paged.resources.asset.summary.title}, ${pagedresourcesassetsummary.title}",
        "properties": {
          "data": {
            "title": "Page Data",
            "description": "The page of resources returned.",
            "items": {
              "$ref": "#/components/schemas/AssetSummary"
            }
          },
          "effectiveTime": {
            "description": "${pagedresourcesassetsummary.effectivetime.description}, ${paged.resources.asset.summary.effective.time.description}",
            "format": "date-time",
            "writeOnly": true
          },
          "links": {
            "title": "Page Links",
            "description": "Hypermedia links that allow navigation to the previous, next, first and last pages.",
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/CursorPageMetadata"
          }
        },
        "description": "${paged.resources.asset.summary.description}, ${pagedresourcesassetsummary.description}"
      },
      "PagedResourcesAssetTagSummary": {
        "title": "${pagedresourcesassettagsummary.title}, ${paged.resources.asset.tag.summary.title}",
        "properties": {
          "data": {
            "title": "Page Data",
            "description": "The page of resources returned.",
            "items": {
              "$ref": "#/components/schemas/AssetTagSummary"
            }
          },
          "effectiveTime": {
            "description": "${paged.resources.asset.tag.summary.effective.time.description}, ${pagedresourcesassettagsummary.effectivetime.description}",
            "format": "date-time",
            "writeOnly": true
          },
          "links": {
            "title": "Page Links",
            "description": "Hypermedia links that allow navigation to the previous, next, first and last pages.",
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/CursorPageMetadata"
          }
        },
        "description": "${pagedresourcesassettagsummary.description}, ${paged.resources.asset.tag.summary.description}"
      },
      "PagedResourcesScanEngineResource": {
        "title": "${pagedresourcesscanengineresource.title}, ${paged.resources.scan.engine.resource.title}",
        "properties": {
          "data": {
            "title": "Page Data",
            "description": "The page of resources returned.",
            "items": {
              "$ref": "#/components/schemas/ScanEngineResource"
            }
          },
          "effectiveTime": {
            "description": "${pagedresourcesscanengineresource.effectivetime.description}, ${paged.resources.scan.engine.resource.effective.time.description}",
            "format": "date-time",
            "writeOnly": true
          },
          "links": {
            "title": "Page Links",
            "description": "Hypermedia links that allow navigation to the previous, next, first and last pages.",
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/CursorPageMetadata"
          }
        },
        "description": "${pagedresourcesscanengineresource.description}, ${paged.resources.scan.engine.resource.description}"
      },
      "PagedResourcesScanResource": {
        "title": "${pagedresourcesscanresource.title}, ${paged.resources.scan.resource.title}",
        "properties": {
          "data": {
            "title": "Page Data",
            "description": "The page of resources returned.",
            "items": {
              "$ref": "#/components/schemas/ScanResource"
            }
          },
          "effectiveTime": {
            "description": "${pagedresourcesscanresource.effectivetime.description}, ${paged.resources.scan.resource.effective.time.description}",
            "format": "date-time",
            "writeOnly": true
          },
          "links": {
            "title": "Page Links",
            "description": "Hypermedia links that allow navigation to the previous, next, first and last pages.",
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/CursorPageMetadata"
          }
        },
        "description": "${paged.resources.scan.resource.description}, ${pagedresourcesscanresource.description}"
      },
      "PagedResourcesScanResourceWithoutAssetIds": {
        "title": "${pagedresourcesscanresource.title}, ${paged.resources.scan.resource.title}",
        "properties": {
          "data": {
            "title": "Page Data",
            "description": "The page of resources returned.",
            "items": {
              "$ref": "#/components/schemas/ScanResource"
            }
          },
          "effectiveTime": {
            "description": "${pagedresourcesscanresource.effectivetime.description}, ${paged.resources.scan.resource.effective.time.description}",
            "format": "date-time",
            "writeOnly": true
          },
          "links": {
            "title": "Page Links",
            "description": "Hypermedia links that allow navigation to the previous, next, first and last pages.",
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/CursorPageMetadata"
          }
        },
        "description": "${paged.resources.scan.resource.description}, ${pagedresourcesscanresource.description}"
      },
      "PagedResourcesVulnerabilitySummary": {
        "title": "${pagedresourcesvulnerabilitysummary.title}, ${paged.resources.vulnerability.summary.title}",
        "properties": {
          "data": {
            "title": "Page Data",
            "description": "The page of resources returned.",
            "items": {
              "$ref": "#/components/schemas/VulnerabilitySummary"
            }
          },
          "effectiveTime": {
            "description": "${paged.resources.vulnerability.summary.effective.time.description}, ${pagedresourcesvulnerabilitysummary.effectivetime.description}",
            "format": "date-time",
            "writeOnly": true
          },
          "links": {
            "title": "Page Links",
            "description": "Hypermedia links that allow navigation to the previous, next, first and last pages.",
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "metadata": {
            "$ref": "#/components/schemas/CursorPageMetadata"
          }
        },
        "description": "${paged.resources.vulnerability.summary.description}, ${pagedresourcesvulnerabilitysummary.description}"
      },
      "RemoveScanEngineConfigurationProperty": {
        "title": "${remove.scan.engine.configuration.property.title}, ${removescanengineconfigurationproperty.title}",
        "properties": {
          "properties": {
            "description": "List of property names to remove from a scan engine.",
            "items": {}
          }
        },
        "description": "${removescanengineconfigurationproperty.description}, ${remove.scan.engine.configuration.property.description}"
      },
      "ScanEngineId": {
        "title": "${scan.engine.id.title}, ${scanengineid.title}",
        "properties": {
          "id": {
            "description": "${scan.engine.id.id.description}, ${scanengineid.id.description}"
          }
        },
        "description": "The identifier of the engine for the scan."
      },
      "ScanEngineResource": {
        "title": "${scanengineresource.title}, ${scan.engine.resource.title}",
        "properties": {
          "host_name": {
            "description": "${scan.engine.resource.host_name.description}, ${scan.engine.resource.host.name.description}, ${scanengineresource.host_name.description}, ${scanengineresource.host.name.description}"
          },
          "id": {
            "$ref": "#/components/schemas/ScanEngineId"
          },
          "last_seen": {
            "description": "${scanengineresource.last.seen.description}, ${scanengineresource.last_seen.description}, ${scan.engine.resource.last_seen.description}, ${scan.engine.resource.last.seen.description}",
            "format": "date-time"
          },
          "name": {
            "description": "${scanengineresource.name.description}, ${scan.engine.resource.name.description}"
          },
          "profile": {
            "$ref": "#/components/schemas/ScanEngineProfile"
          },
          "registered": {
            "description": "${scan.engine.resource.registered.description}, ${scanengineresource.registered.description}",
            "format": "date-time"
          },
          "status": {
            "description": "${scan.engine.resource.status.description}, ${scanengineresource.status.description}"
          }
        },
        "description": "${scan.engine.resource.description}, ${scanengineresource.description}"
      },
      "ScanId": {
        "title": "${scanid.title}, ${scan.id.title}",
        "properties": {
          "id": {
            "description": "${scanid.id.description}, ${scan.id.id.description}"
          }
        },
        "description": "The identifier of the scan."
      },
      "ScanResource": {
        "title": "${scanresource.title}, ${scan.resource.title}",
        "properties": {
          "asset_ids": {
            "description": "${scanresource.asset.ids.description}, ${scanresource.asset_ids.description}, ${scan.resource.asset_ids.description}, ${scan.resource.asset.ids.description}",
            "items": {}
          },
          "details": {
            "description": "${scanresource.details.description}, ${scan.resource.details.description}"
          },
          "engine_id": {
            "$ref": "#/components/schemas/ScanEngineId"
          },
          "finished": {
            "description": "${scanresource.finished.description}, ${scan.resource.finished.description}",
            "format": "date-time"
          },
          "id": {
            "$ref": "#/components/schemas/ScanId"
          },
          "name": {
            "description": "${scanresource.name.description}, ${scan.resource.name.description}"
          },
          "started": {
            "description": "${scanresource.started.description}, ${scan.resource.started.description}",
            "format": "date-time"
          },
          "status": {
            "description": "${scan.resource.status.description}, ${scanresource.status.description}"
          }
        },
        "description": "${scanresource.description}, ${scan.resource.description}"
      },
      "ScanResourceWithoutAssetIds": {
        "title": "${scanresource.title}, ${scan.resource.title}",
        "properties": {
          "details": {
            "description": "${scanresource.details.description}, ${scan.resource.details.description}"
          },
          "engine_id": {
            "$ref": "#/components/schemas/ScanEngineId"
          },
          "finished": {
            "description": "${scanresource.finished.description}, ${scan.resource.finished.description}",
            "format": "date-time"
          },
          "id": {
            "$ref": "#/components/schemas/ScanId"
          },
          "name": {
            "description": "${scanresource.name.description}, ${scan.resource.name.description}"
          },
          "started": {
            "description": "${scanresource.started.description}, ${scan.resource.started.description}",
            "format": "date-time"
          },
          "status": {
            "description": "${scan.resource.status.description}, ${scanresource.status.description}"
          }
        },
        "description": "${scanresource.description}, ${scan.resource.description}"
      },
      "SolutionId": {
        "title": "${solution.id.title}, ${solutionid.title}",
        "properties": {
          "entityType": {
            "$ref": "#/components/schemas/EntityType"
          },
          "id": {
            "description": "${solutionid.id.description}, ${solution.id.id.description}"
          }
        },
        "description": "${solutionid.description}, ${solution.id.description}"
      },
      "UnscannedAssetResource": {
        "title": "${unscanned.asset.resource.title}, ${unscannedassetresource.title}",
        "properties": {
          "id": {
            "description": "${unscannedassetresource.id.description}, ${unscanned.asset.resource.id.description}"
          },
          "reason": {
            "description": "${unscanned.asset.resource.reason.description}, ${unscannedassetresource.reason.description}"
          }
        },
        "description": "${unscannedassetresource.description}, ${unscanned.asset.resource.description}"
      },
      "UpdateEnginePropertiesForm": {
        "title": "${updateenginepropertiesform.title}, ${update.engine.properties.form.title}",
        "properties": {
          "properties": {
            "description": "The properties to apply to the engine payload.",
            "items": {
              "$ref": "#/components/schemas/ScanEngineConfigurationPropertyInput"
            }
          }
        },
        "description": "${updateenginepropertiesform.description}, ${update.engine.properties.form.description}"
      },
      "VulnerabilityCheckId": {
        "title": "${vulnerabilitycheckid.title}, ${vulnerability.check.id.title}",
        "properties": {
          "id": {
            "description": "${vulnerability.check.id.id.description}, ${vulnerabilitycheckid.id.description}"
          }
        },
        "description": "${vulnerabilitycheckid.description}, ${vulnerability.check.id.description}"
      },
      "VulnerabilityId": {
        "title": "${vulnerabilityid.title}, ${vulnerability.id.title}",
        "properties": {
          "entityType": {
            "$ref": "#/components/schemas/EntityType"
          },
          "id": {
            "description": "${vulnerabilityid.id.description}, ${vulnerability.id.id.description}"
          }
        },
        "description": "The identifier of the vulnerability."
      },
      "VulnerabilitySummary": {
        "title": "${vulnerabilitysummary.title}, ${vulnerability.summary.title}",
        "properties": {
          "added": {
            "description": "The date the vulnerability coverage was added. The format is an ISO 8601 date, `YYYY-MM-DD`.",
            "format": "date-time"
          },
          "categories": {
            "description": "Comma-separated list of categories the vulnerability is classified under."
          },
          "cves": {
            "description": "All <a target=\"_blank\" href=\"https://cve.mitre.org/\">CVE</a>s assigned to this vulnerability."
          },
          "cvss_v2_access_complexity": {
            "description": "Access Complexity (AC) component which measures the complexity of the attack required to exploit the vulnerability once an attacker has gained access to the target system. <table> <tr><th>Access Complexity</th><th>Description</th></tr> <tr><td>High (\"high\")</td><td>Specialized access conditions exist.</td></tr> <tr><td>Medium (\"medium\")</td><td>The access conditions are somewhat specialized.</td></tr> <tr><td>Low (\"low\")</td><td>Specialized access conditions or extenuating circumstances do not exist.</td></tr> </table>",
            "enum": [
              "L",
              "M",
              "H"
            ]
          },
          "cvss_v2_access_vector": {
            "description": "Access Vector (Av) component which reflects how the vulnerability is exploited. <table> <tr><th>Access Vector</th><th>Description</th></tr> <tr><td>Local (\"local\")</td><td>A vulnerability exploitable with only local access requires the attacker to have either physical access to the vulnerable system or a local (shell) account.</td></tr> <tr><td>Adjacent Network (\"adjacent\")</td><td>A vulnerability exploitable with adjacent network access requires the attacker to have access to either the broadcast or collision domain of the vulnerable software.</td></tr> <tr><td>Network (\"network\")</td><td>A vulnerability exploitable with network access means the vulnerable software is bound to the network stack and the attacker does not require local network access or local access. Such a vulnerability is often termed \"remotely exploitable\".</td></tr> </table>",
            "enum": [
              "L",
              "A",
              "N"
            ]
          },
          "cvss_v2_authentication": {
            "description": "Authentication (Au) component which measures the number of times an attacker must authenticate to a target in order to exploit a vulnerability. \n<table> <tr><th>Authentication</th><th>Description</th></tr> <tr><td>Multiple (\"multiple\")</td><td>Exploiting the vulnerability requires that the attacker authenticate two or more times, even if the same credentials are used each time.</td></tr> <tr><td>Single (\"single\")</td><td>The vulnerability requires an attacker to be logged into the system.</td></tr> <tr><td>None (\"none\")</td><td>Authentication is not required to exploit the vulnerability.</td></tr> </table>",
            "enum": [
              "N",
              "S",
              "M"
            ]
          },
          "cvss_v2_availability_impact": {
            "description": "Availability Impact (A) component which measures the impact to availability of a successfully exploited vulnerability. \n<table> <tr><th>Availability Impact</th><th>Description</th></tr> <tr><td>None (\"none)</td><td>There is no impact to the availability of the system.</td></tr> <tr><td>Partial (\"partial\")</td><td>There is reduced performance or interruptions in resource availability.</td></tr> <tr><td>Complete (\"complete\")</td><td>There is a total shutdown of the affected resource. The attacker can render the resource completely unavailable.</td></tr> </table>",
            "enum": [
              "N",
              "P",
              "C"
            ]
          },
          "cvss_v2_confidentiality_impact": {
            "description": "Confidentiality Impact (C) component which measures the impact on confidentiality of a successfully exploited vulnerability. \n<table> <tr><th>Confidentiality Impact</th><th>Description</th></tr> <tr><td>None (\"none\")</td><td>There is no impact to the confidentiality of the system.</td></tr> <tr><td>Partial (\"partial\")</td><td>There is considerable informational disclosure. Access to some system files is possible, but the attacker does not have control over what is obtained, or the scope of the loss is constrained.</td></tr> <tr><td>Complete (\"complete\")</td><td>There is total information disclosure, resulting in all system files being revealed. The attacker is able to read all of the system's data (memory, files, etc.)</td></tr> </table>",
            "enum": [
              "N",
              "P",
              "C"
            ]
          },
          "cvss_v2_exploit_score": {
            "description": "The CVSS exploit score.",
            "format": "double"
          },
          "cvss_v2_impact_score": {
            "description": "The CVSS impact score.",
            "format": "double"
          },
          "cvss_v2_integrity_impact": {
            "description": "Integrity Impact (I) component measures the impact to integrity of a successfully exploited vulnerability. \n<table> <tr><th>Integrity Impact</th><th>Description</th></tr> <tr><td>None (\"none\")</td><td>There is no impact to the integrity of the system.</td></tr> <tr><td>Partial (\"partial\")</td><td>Modification of some system files or information is possible, but the attacker does not have control over what can be modified, or the scope of what the attacker can affect is limited.</td></tr> <tr><td>Complete (\"complete\")</td><td>There is a total compromise of system integrity. There is a complete loss of system protection, resulting in the entire system being compromised. The attacker is able to modify any files on the target system.</td></tr> </table>",
            "enum": [
              "N",
              "P",
              "C"
            ]
          },
          "cvss_v2_score": {
            "description": "The CVSS score, which ranges from 0-10.",
            "format": "double"
          },
          "cvss_v2_vector": {
            "description": "The <a target=\"_blank\" href=\"https://www.first.org/cvss/v2/guide\">CVSS v2</a> vector."
          },
          "cvss_v3_attack_complexity": {
            "description": "Attack Complexity (AC) component with measures the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. \n\n<table> <tr><th>Access Complexity</th><th>Description</th></tr> <tr><td>Low (\"low\")</td><td>Specialized access conditions or extenuating circumstances do not exist.</td></tr> <tr><td>High (\"high\")</td><td>A successful attack depends on conditions beyond the attacker's control.</td></tr> </table>",
            "enum": [
              "L",
              "H"
            ]
          },
          "cvss_v3_attack_vector": {
            "description": "Attack Vector (AV) component which measures context by which vulnerability exploitation is possible.</td></tr> <table> <tr><th>Access Vector</th><th>Description</th></tr> <tr><td>Local (\"local\")</td><td>A vulnerability exploitable with only local access requires the attacker to have either physical access to the vulnerable system or a local (shell) account.</td></tr> <tr><td>Adjacent (\"adjacent\")</td><td>A vulnerability exploitable with adjacent network access requires the attacker to have access to either the broadcast or collision domain of the vulnerable software.</td></tr> <tr><td>Network (\"network\")</td><td>A vulnerability exploitable with network access means the vulnerable software is bound to the network stack and the attacker does not require local network access or local access. Such a vulnerability is often termed \"remotely exploitable\".</td></tr> <tr><td>Physical (\"physical\")</td><td>A vulnerability exploitable with Physical access requires the attacker to physically touch or manipulate the vulnerable component.</td></tr> </table>",
            "enum": [
              "N",
              "A",
              "L",
              "P"
            ]
          },
          "cvss_v3_availability_impact": {
            "description": "Availability Impact (A) measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. \n\n<table> <tr><th>Availability Impact</th><th>Description</th></tr> <tr><td>High (\"high\")</td><td>There is total loss of availability, resulting in the attacker being able to fully deny access to resources in the impacted component; this loss is either sustained (while the attacker continues to deliver the attack) or persistent (the condition persists even after the attack has completed).</td></tr> <tr><td>Low (\"low\")</td><td>There is reduced performance or interruptions in resource availability. Even if repeated exploitation of the vulnerability is possible, the attacker does not have the ability to completely deny service to legitimate users.</td></tr> <tr><td>None (\"none\")</td><td>There is no impact to availability within the impacted component.</td></tr> </table>",
            "enum": [
              "N",
              "L",
              "H"
            ]
          },
          "cvss_v3_confidentiality_impact": {
            "description": "Confidentiality Impact (C) component which measures the impact on confidentiality of a successfully exploited vulnerability. \n\n<table> <tr><th>Confidentiality Impact</th><th>Description</th></tr> <tr><td>High (\"high\")</td><td>There is total loss of confidentiality, resulting in all resources within the impacted component being divulged to the attacker.</td></tr> <tr><td>Low (\"low\")</td><td>There is some loss of confidentiality. Access to some restricted information is obtained, but the attacker does not have control over what information is obtained, or the amount or kind of loss is constrained.</td></tr> <tr><td>None (\"none\")</td><td>There is no loss of confidentiality within the impacted component.</td></tr> </table>",
            "enum": [
              "N",
              "L",
              "H"
            ]
          },
          "cvss_v3_exploit_score": {
            "description": "The CVSS exploit score.",
            "format": "double"
          },
          "cvss_v3_impact_score": {
            "description": "The CVSS impact score.",
            "format": "double"
          },
          "cvss_v3_integrity_impact": {
            "description": "Integrity Impact (I) measures the impact to integrity of a successfully exploited vulnerability. Integrity refers to the trustworthiness and veracity of information. \n\n<table> <tr><th>Integrity Impact</th><th>Description</th></tr> <tr><td>High (\"high\")</td><td>There is a total loss of integrity, or a complete loss of protection.</td></tr> <tr><td>Low (\"low\")</td><td>Modification of data is possible, but the attacker does not have control over the consequence of a modification, or the amount of modification is constrained.</td></tr> <tr><td>None (\"none\")</td><td>There is no loss of integrity within the impacted component.</td></tr> </table>",
            "enum": [
              "N",
              "L",
              "H"
            ]
          },
          "cvss_v3_privileges_required": {
            "description": "Privileges Required (PR) measures the level of privileges an attacker must possess before successfully exploiting the vulnerability. \n\n<table> <tr><th>Privileges Required</th><th>Description</th></tr> <tr><td>High (\"high\")</td><td>The attacker is authorized with (i.e. requires) privileges that provide significant (e.g. administrative) control over the vulnerable component that could affect component-wide settings and files.</td></tr> <tr><td>Low (\"low\")</td><td>The attacker is authorized with (i.e. requires) privileges that provide basic user capabilities that could normally affect only settings and files owned by a user.</td></tr> <tr><td>None (\"none\")</td><td>The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files to carry out an attack.</td></tr> </table>",
            "enum": [
              "N",
              "L",
              "H"
            ]
          },
          "cvss_v3_scope": {
            "description": "Scope (S) measures the collection of privileges defined by a computing authority (e.g. an application, an operating system, or a sandbox environment) when granting access to computing resources (e.g. files, CPU, memory, etc). These privileges are assigned based on some method of identification and authorization. \n\n<table> <tr><th>Scope</th><th>Description</th></tr> <tr><td>Unchanged (\"unchanged\")</td><td>An exploited vulnerability can only affect resources managed by the same authority. In this case the vulnerable component and the impacted component are the same.</td></tr> <tr><td>Changed (\"changed\")</td><td>An exploited vulnerability can affect resources beyond the authorization privileges intended by the vulnerable component. In this case the vulnerable component and the impacted component are different.</td></tr> </table>",
            "enum": [
              "U",
              "C"
            ]
          },
          "cvss_v3_score": {
            "description": "The CVSS score, which ranges from 0-10.",
            "format": "double"
          },
          "cvss_v3_user_interaction": {
            "description": "User Interaction (UI) measures the requirement for a user, other than the attacker, to participate in the successful compromise of the vulnerable component. \n\n<table> <tr><th>User Interaction</th><th>Description</th></tr> <tr><td>None (\"none\")</td><td>The vulnerable system can be exploited without interaction from any user.</td></tr> <tr><td>Required (\"required\")</td><td>Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited.</td></tr> </table>",
            "enum": [
              "N",
              "R"
            ]
          },
          "cvss_v3_vector": {
            "description": "The <a target=\"_blank\" href=\"https://www.first.org/cvss/specification-document\">CVSS v3</a> vector."
          },
          "denial_of_service": {
            "description": "Whether the vulnerability can lead to Denial of Service (DoS)."
          },
          "description": {
            "description": "A verbose description of the vulnerability."
          },
          "exploits": {
            "description": "The exploits that can be used to exploit a vulnerability.",
            "items": {
              "$ref": "#/components/schemas/ExploitSummary"
            }
          },
          "id": {
            "$ref": "#/components/schemas/VulnerabilityId"
          },
          "links": {
            "description": "References to security standards this vulnerability is a part of.",
            "items": {
              "$ref": "#/components/schemas/AdvisoryLinkSummary"
            }
          },
          "malware_kits": {
            "description": "The malware kits that are known to be used to exploit the vulnerability.",
            "items": {
              "$ref": "#/components/schemas/MalwareKitSummary"
            }
          },
          "modified": {
            "description": "The last date the vulnerability was modified. The format is an ISO 8601 date, `YYYY-MM-DD`.",
            "format": "date-time"
          },
          "pci_cvss_score": {
            "description": "The CVSS score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10.",
            "format": "double"
          },
          "pci_fail": {
            "description": "Whether if present on a host this vulnerability would cause a PCI failure. `true` if compliance status is `\"fail\"`, `false` otherwise."
          },
          "pci_severity_score": {
            "description": "The severity score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10.",
            "format": "int32"
          },
          "pci_special_notes": {
            "description": "Any special notes or remarks about the vulnerability that pertain to PCI compliance."
          },
          "pci_status": {
            "description": "The PCI compliance status."
          },
          "published": {
            "description": "The date the vulnerability was first published or announced. The format is an ISO 8601 date, `YYYY-MM-DD`.",
            "format": "date-time"
          },
          "references": {
            "description": "References to security standards this vulnerability is a part of, in condensed format (comma-separated): `[<source>:<id>,...]`."
          },
          "risk_score": {
            "description": "The risk score of the vulnerability. If using the default Rapid7 Real Risk™ model, this value ranges from 0-1000.",
            "format": "double"
          },
          "severity": {
            "description": "The severity of the vulnerability.",
            "enum": [
              "none",
              "informational",
              "low",
              "moderate",
              "severe",
              "critical"
            ]
          },
          "severity_score": {
            "description": "The severity score of the vulnerability, on a scale of 0-10.",
            "format": "int32"
          },
          "title": {
            "description": "The title (summary) of the vulnerability."
          }
        },
        "description": "${vulnerability.summary.description}, ${vulnerabilitysummary.description}"
      },
      "AssetTagSummary": {
        "title": "Asset Tags",
        "properties": {
          "name": {
            "description": "The stored value."
          },
          "type": {
            "description": "The type of information stored and displayed. For sites, the value is `\"SITE\"`."
          }
        },
        "description": "${assettagsummary.description}, ${asset.tag.summary.description}"
      },
      "CredentialAssessmentSummary": {
        "title": "Credential Assessments",
        "properties": {
          "port": {
            "description": "The port the authentication was used on.",
            "format": "int64"
          },
          "protocol": {
            "description": "The protocol the authentication was used on."
          },
          "status": {
            "description": "The authentication of the last scan performed."
          }
        },
        "description": "${credential.assessment.summary.description}, ${credentialassessmentsummary.description}"
      },
      "CursorPageMetadata": {
        "title": "Cursored Page Metadata",
        "type": "object",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "The stateless cursor associated with the series of page requests being made."
          },
          "number": {
            "type": "integer",
            "description": "The index (zero-based) of the current page returned.",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "description": "The maximum size of the page returned.",
            "format": "int64"
          },
          "totalPages": {
            "type": "integer",
            "description": "The total number of pages available.",
            "format": "int64"
          },
          "totalResources": {
            "type": "integer",
            "description": "The total number of resources available across all pages.",
            "format": "int64"
          }
        },
        "description": "The details of pagination indicating which page was returned, and how the remaining pages can be retrieved for the same cursored result set."
      },
      "Error": {
        "title": "Error",
        "type": "object",
        "properties": {
          "localized_message": {
            "type": "string",
            "description": "An optional localized message indicating the cause or reason for failure."
          },
          "message": {
            "type": "string",
            "description": "The messages indicating the cause or reason for failure."
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code for the error (same as in the HTTP response).",
            "enum": [
              "100",
              "101",
              "102",
              "103",
              "200",
              "201",
              "202",
              "203",
              "204",
              "205",
              "206",
              "207",
              "208",
              "226",
              "300",
              "301",
              "302",
              "303",
              "304",
              "305",
              "307",
              "308",
              "400",
              "401",
              "402",
              "403",
              "404",
              "405",
              "406",
              "407",
              "408",
              "409",
              "410",
              "411",
              "412",
              "413",
              "414",
              "415",
              "416",
              "417",
              "418",
              "419",
              "420",
              "421",
              "422",
              "423",
              "424",
              "425",
              "426",
              "428",
              "429",
              "431",
              "451",
              "500",
              "501",
              "502",
              "503",
              "504",
              "505",
              "506",
              "507",
              "508",
              "509",
              "510",
              "511"
            ]
          }
        },
        "description": "The details for an error encountered by the API."
      },
      "ExploitSummary": {
        "title": "Exploit",
        "properties": {
          "description": {
            "description": "A verbose description of the exploit."
          },
          "id": {
            "description": "The identifier of the exploit."
          },
          "name": {
            "description": "The name of the exploit."
          },
          "rank": {
            "description": "How common the exploit is used.",
            "enum": [
              "manual",
              "normal",
              "average",
              "low",
              "good",
              "great",
              "excellent"
            ]
          },
          "skill_level": {
            "description": "The level of skill required to use the exploit.",
            "enum": [
              "novice",
              "intermediate",
              "expert"
            ]
          },
          "source": {
            "description": "Details about where the exploit is defined.",
            "enum": [
              "exploitdb",
              "metasploit"
            ]
          }
        },
        "description": "${exploit.summary.description}, ${exploitsummary.description}"
      },
      "CompositeHealthSummary": {
        "title": "Health ",
        "properties": {
          "components": {
            "additionalProperties": {
              "$ref": "#/components/schemas/HealthComponent"
            },
            "description": "The details of the health of each component in the service (optional)."
          },
          "duration": {
            "description": "${composite.health.summary.duration.description}, ${compositehealthsummary.duration.description}"
          },
          "status": {
            "description": "The status of the service.",
            "enum": [
              "UP",
              "DOWN",
              "OUT-OF-SERVICE",
              "UNKNOWN"
            ]
          },
          "summary": {
            "$ref": "#/components/schemas/HealthSummary"
          }
        },
        "description": "A overview of the health of the service."
      },
      "HealthComponent": {
        "title": "Health Component",
        "properties": {
          "description": {
            "description": "${healthcomponent.description.description}, ${health.component.description.description}"
          },
          "status": {
            "description": "${healthcomponent.status.description}, ${health.component.status.description}"
          }
        },
        "description": "The status of an individual component of health."
      },
      "HealthSummary": {
        "title": "Health Summary",
        "properties": {
          "down": {
            "description": "The components that have a health status of `\"down\"`.",
            "items": {}
          },
          "outOfService": {
            "description": "The components that have a health status of `\"out-of-service\"`.",
            "items": {}
          },
          "unknown": {
            "description": "The components that have a health status of `\"unknown\"`.",
            "items": {}
          },
          "up": {
            "description": "The components that have a health status of `\"up\"`.",
            "items": {}
          }
        },
        "description": "A summarization of the health of the service (optional)."
      },
      "Link": {
        "title": "Link",
        "properties": {
          "deprecation": {
            "description": "${link.deprecation.description}"
          },
          "href": {
            "description": "A hypertext reference, which is either a URI (see <a target=\"_blank\" href=\"https://tools.ietf.org/html/rfc3986\">RFC 3986</a>) or URI template (see <a target=\"_blank\" href=\"https://tools.ietf.org/html/rfc6570\">RFC 6570</a>). "
          },
          "hreflang": {
            "description": "${link.hreflang.description}"
          },
          "media": {
            "description": "${link.media.description}"
          },
          "name": {
            "description": "${link.name.description}"
          },
          "profile": {
            "description": "${link.profile.description}"
          },
          "rel": {
            "description": "The link relation type. This value is one from the <a target=\"_blank\" href=\"https://tools.ietf.org/html/rfc5988#section-6.2\">Link Relation Type Registry</a> or is the type of resource being linked to."
          },
          "title": {
            "description": "Link title."
          },
          "type": {
            "description": "${link.type.description}"
          }
        },
        "description": "A hypermedia link."
      },
      "MalwareKitSummary": {
        "title": "Malware Kit",
        "properties": {
          "description": {
            "description": "A known Malware Kit that can be used to compromise a vulnerability."
          },
          "name": {
            "$ref": "#/components/schemas/MalwareKitId"
          },
          "popularity": {
            "description": "The popularity of the malware kit.",
            "enum": [
              "rare",
              "uncommon",
              "occasional",
              "common",
              "popular",
              "favored",
              "undefined"
            ]
          }
        },
        "description": "${malwarekitsummary.description}, ${malware.kit.summary.description}"
      },
      "Pageable": {
        "properties": {
          "page": {
            "minimum": 0,
            "format": "int32"
          },
          "size": {
            "minimum": 1,
            "format": "int32"
          },
          "sort": {
            "items": {}
          }
        }
      },
      "Region": {
        "type": "string",
        "example": "us",
        "enum": [
          "us",
          "us2",
          "us3",
          "eu",
          "ca",
          "au",
          "ap"
        ]
      },
      "ScanEngineConfiguration": {
        "title": "Scan Engine Configuration",
        "properties": {
          "lastRetrieved": {
            "description": "Timestamp the configuration was last retrieved from the engine by the Insight Platform.",
            "format": "date-time"
          },
          "properties": {
            "description": "List of custom properties and their value set on the scan engine.",
            "items": {}
          }
        },
        "description": "The current configuration applied to the scan engine."
      },
      "ScanEngineProfile": {
        "title": "Scan Engine Profile",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/ScanEngineConfiguration"
          }
        },
        "description": "The Profile associated with the scan engine."
      },
      "ScanEngineConfigurationPropertyInput": {
        "title": "Scan Engine Properties Input",
        "properties": {
          "name": {
            "description": "Name of the scan engine configuration property (e.g. com.rapid7.*)."
          },
          "value": {
            "description": "Value the configuration property should be set to."
          }
        },
        "description": "${scan.engine.configuration.property.input.description}, ${scanengineconfigurationpropertyinput.description}"
      },
      "ScanForm": {
        "title": "ScanForm",
        "properties": {
          "asset_ids": {
            "uniqueItems": true,
            "description": "The identifiers of the assets to scan.",
            "items": {}
          },
          "credential_sources": {
            "uniqueItems": true,
            "description": "The names of the sites on the Nexpose console to pull asset credentials from.",
            "items": {}
          },
          "engine_ids": {
            "uniqueItems": true,
            "description": "The identifiers of the engines to use for the scan.",
            "items": {}
          },
          "exclusions": {
            "$ref": "#/components/schemas/ScanForm"
          },
          "name": {
            "description": "The name of the scan."
          },
          "result_consumer": {
            "description": "The name of the site on the Nexpose console used to ingest the scanned assets."
          },
          "solution_ids": {
            "uniqueItems": true,
            "description": "The identifiers of the solutions used to reduce the scope of the scan.",
            "items": {}
          },
          "start_time": {
            "description": "The time at which to start the scan."
          },
          "vulnerability_ids": {
            "uniqueItems": true,
            "description": "The identifiers of the vulnerabilities used to reduce the scope of the scan.",
            "items": {}
          }
        },
        "description": "The payload for starting a scan."
      },
      "UniqueIdSummary": {
        "title": "Unique Identifiers",
        "properties": {
          "id": {
            "description": "The unique identifier."
          },
          "source": {
            "description": "The source of the unique identifier."
          }
        },
        "description": "${unique.id.summary.description}, ${uniqueidsummary.description}"
      },
      "AssetVulnerabilityResultSummary": {
        "title": "Vulnerabilities",
        "properties": {
          "check_id": {
            "$ref": "#/components/schemas/VulnerabilityCheckId"
          },
          "endpoint": {
            "$ref": "#/components/schemas/Endpoint"
          },
          "first_found": {
            "description": "The first time the vulnerability was discovered.",
            "format": "date-time"
          },
          "key": {
            "description": "The identifier of the assessment key."
          },
          "last_found": {
            "description": "The most recent time the vulnerability was discovered.",
            "format": "date-time"
          },
          "nic": {
            "description": "The NIC of the vulnerability finding."
          },
          "port": {
            "description": "For services vulnerabilities, the port that is vulnerable.",
            "format": "int32"
          },
          "proof": {
            "description": "The identifier of the vulnerability proof."
          },
          "protocol": {
            "description": "For services vulnerabilities, the protocol that is vulnerable."
          },
          "reintroduced": {
            "description": "${assetvulnerabilityresultsummary.reintroduced.description}, ${asset.vulnerability.result.summary.reintroduced.description}",
            "format": "date-time"
          },
          "remediation_date": {
            "description": "${assetvulnerabilityresultsummary.remediation_date.description}, ${asset.vulnerability.result.summary.remediation.date.description}, ${assetvulnerabilityresultsummary.remediation.date.description}, ${asset.vulnerability.result.summary.remediation_date.description}",
            "format": "date-time"
          },
          "solution_fix": {
            "description": "The solution fix for the vulnerability."
          },
          "solution_id": {
            "$ref": "#/components/schemas/SolutionId"
          },
          "solution_summary": {
            "description": "The summary for the solution for the vulnerability."
          },
          "solution_type": {
            "description": "The solution type for the vulnerability."
          },
          "status": {
            "description": "The status of the vulnerability finding.",
            "enum": [
              "UNKNOWN",
              "NOT_VULNERABLE",
              "VULNERABLE_EXPL",
              "VULNERABLE_VERS",
              "VULNERABLE_POTENTIAL",
              "SKIPPED_VERS",
              "SKIPPED_DOS",
              "UNEXPECTED_ERR",
              "SKIPPED_DISABLED",
              "NOT_VULN_DONT_STORE",
              "EXCEPTION_VULN_EXPL",
              "EXCEPTION_VULN_VERS",
              "EXCEPTION_VULN_POTL",
              "OVERRIDDEN_VULN_VERS",
              "SUPERSEDED"
            ]
          },
          "vulnerability_id": {
            "$ref": "#/components/schemas/VulnerabilityId"
          }
        },
        "description": "${asset.vulnerability.result.summary.description}, ${assetvulnerabilityresultsummary.description}"
      },
      "AdvisoryLinkSummary": {
        "title": "Vulnerability Reference",
        "properties": {
          "href": {
            "description": "${advisory.link.summary.href.description}, ${advisorylinksummary.href.description}"
          },
          "id": {
            "description": "${advisorylinksummary.id.description}, ${advisory.link.summary.id.description}"
          },
          "source": {
            "description": "${advisorylinksummary.source.description}, ${advisory.link.summary.source.description}"
          }
        },
        "description": "${advisorylinksummary.description}, ${advisory.link.summary.description}"
      },
      "VulnerabilitySearch": {
        "title": "Vulnerability Search",
        "properties": {
          "vulnerability": {
            "description": "Search expression with criteria for searching on vulnerabilities."
          }
        },
        "description": "Criteria for searching vulnerabilities."
      }
    },
    "securitySchemes": {
      "api-key": {
        "type": "apiKey",
        "name": "X-Api-Key",
        "in": "header",
        "bearerFormat": "Rapid7 API Token"
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "Administration",
      "tags": [
        "Discovery",
        "Health",
        "Authentication"
      ]
    },
    {
      "name": "Resources",
      "tags": [
        "Asset",
        "Scan",
        "Site",
        "Vulnerability"
      ]
    }
  ]
}