naftiko: 1.0.0-alpha2 info: label: InsightVM API — Site description: 'InsightVM API — Site. 84 operations. Lead operation: Site Assets. Self-contained Naftiko capability covering one business surface.' tags: - Rapid7 - Site created: '2026-05-20' modified: '2026-05-20' binds: - namespace: env keys: RAPID7_API_KEY: RAPID7_API_KEY capability: consumes: - type: http namespace: insightvm-console-swagger-site baseUri: https://localhost:3780 description: InsightVM API — Site business capability. Self-contained, no shared references. resources: - name: api-3-sites-id-assets path: /api/3/sites/{id}/assets operations: - name: getsiteassets method: GET description: Site Assets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: page in: query type: integer description: The index of the page (zero-based) to retrieve. - name: size in: query type: integer description: The number of records per page to retrieve. - name: sort in: query type: array 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.' - name: removesiteassets method: DELETE description: Site Assets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites path: /api/3/sites operations: - name: getsites method: GET description: Sites outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: page in: query type: integer description: The index of the page (zero-based) to retrieve. - name: size in: query type: integer description: The number of records per page to retrieve. - name: sort in: query type: array 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.' - name: createsite method: POST description: Sites outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: site in: body type: string description: Resource for creating a site configuration. - name: body in: body type: object description: Request body (JSON). required: true - name: api-3-sites-id path: /api/3/sites/{id} operations: - name: getsite method: GET description: Site outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: updatesite method: PUT description: Site outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: site in: body type: string description: Resource for updating a site configuration. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deletesite method: DELETE description: Site outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-alerts path: /api/3/sites/{id}/alerts operations: - name: getsitealerts method: GET description: Site Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: deleteallsitealerts method: DELETE description: Site Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-alerts-smtp path: /api/3/sites/{id}/alerts/smtp operations: - name: getsitesmtpalerts method: GET description: Site SMTP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: createsitesmtpalert method: POST description: Site SMTP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: string description: Resource for creating a new SMTP alert. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: setsitesmtpalerts method: PUT description: Site SMTP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: array description: Array of resources for updating all SMTP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deleteallsitesmtpalerts method: DELETE description: Site SMTP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-alerts-smtp-alertid path: /api/3/sites/{id}/alerts/smtp/{alertId} operations: - name: getsitesmtpalert method: GET description: Site SMTP Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: updatesitesmtpalert method: PUT description: Site SMTP Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: string description: Resource for updating the specified SMTP alert. - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deletesitesmtpalert method: DELETE description: Site SMTP Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: api-3-sites-id-alerts-snmp path: /api/3/sites/{id}/alerts/snmp operations: - name: getsitesnmpalerts method: GET description: Site SNMP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: createsitesnmpalert method: POST description: Site SNMP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: string description: Resource for creating a new SNMP alert. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: setsitesnmpalerts method: PUT description: Site SNMP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: array description: Array of resources for updating all SNMP alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deleteallsitesnmpalerts method: DELETE description: Site SNMP Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-alerts-snmp-alertid path: /api/3/sites/{id}/alerts/snmp/{alertId} operations: - name: getsitesnmpalert method: GET description: Site SNMP Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: updatesitesnmpalert method: PUT description: Site SNMP Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: string description: Resource for updating the specified SNMP alert. - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deletesitesnmpalert method: DELETE description: Site SNMP Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: api-3-sites-id-alerts-syslog path: /api/3/sites/{id}/alerts/syslog operations: - name: getsitesyslogalerts method: GET description: Site Syslog Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: createsitesyslogalert method: POST description: Site Syslog Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: string description: Resource for creating a new Syslog alert. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: setsitesyslogalerts method: PUT description: Site Syslog Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: array description: Array of resources for updating all Syslog alerts defined in the site. Alerts defined in the site that are omitted from this request will be deleted from the site. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deleteallsitesyslogalerts method: DELETE description: Site Syslog Alerts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-alerts-syslog-alertid path: /api/3/sites/{id}/alerts/syslog/{alertId} operations: - name: getsitesyslogalert method: GET description: Site Syslog Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: updatesitesyslogalert method: PUT description: Site Syslog Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: alert in: body type: string description: Resource for updating the specified Syslog alert. - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deletesitesyslogalert method: DELETE description: Site Syslog Alert outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: alertId in: path type: integer description: The identifier of the alert. required: true - name: api-3-sites-id-assets-assetid path: /api/3/sites/{id}/assets/{assetId} operations: - name: removeassetfromsite method: DELETE description: Site Asset outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: assetId in: path type: integer description: The identifier of the asset. required: true - name: api-3-sites-id-discovery-connection path: /api/3/sites/{id}/discovery_connection operations: - name: getsitediscoveryconnection method: GET description: Site Discovery Connection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: setsitediscoveryconnection method: PUT description: Site Discovery Connection outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: connectionId in: body type: integer description: The identifier of the discovery connection. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-discovery-search-criteria path: /api/3/sites/{id}/discovery_search_criteria operations: - name: getsitediscoverysearchcriteria method: GET description: Site Discovery Search Criteria outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: setsitediscoverysearchcriteria method: PUT description: Site Discovery Search Criteria outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: param1 in: body type: string description: param1 required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-excluded-asset-groups path: /api/3/sites/{id}/excluded_asset_groups operations: - name: getexcludedassetgroups method: GET description: Site Excluded Asset Groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: updateexcludedassetgroups method: PUT description: Site Excluded Asset Groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assetGroupIds in: body type: array description: Array of asset group identifiers. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: removeallexcludedassetgroups method: DELETE description: Site Excluded Asset Groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-excluded-asset-groups-assetgroupid path: /api/3/sites/{id}/excluded_asset_groups/{assetGroupId} operations: - name: removeexcludedassetgroup method: DELETE description: Site Excluded Asset Group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: assetGroupId in: path type: integer description: The identifier of the asset group. required: true - name: api-3-sites-id-excluded-targets path: /api/3/sites/{id}/excluded_targets operations: - name: getexcludedtargets method: GET description: Site Excluded Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: addexcludedtargets method: POST description: Site Excluded Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: scanTargetsToAdd in: body type: array description: List of addresses to add to the site's excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. - name: body in: body type: object description: Request body (JSON). required: true - name: updateexcludedtargets method: PUT description: Site Excluded Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanTargets in: body type: array description: List of addresses to be the site's new excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: removeexcludedtargets method: DELETE description: Site Excluded Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: scanTargetsToRemove in: body type: array description: List of address to remove from the sites excluded scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. - name: api-3-sites-id-included-asset-groups path: /api/3/sites/{id}/included_asset_groups operations: - name: getincludedassetgroups method: GET description: Site Included Asset Groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: updateincludedassetgroups method: PUT description: Site Included Asset Groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: assetGroupIds in: body type: array description: Array of asset group identifiers. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: removeallincludedassetgroups method: DELETE description: Site Included Asset Groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-included-asset-groups-assetgroupid path: /api/3/sites/{id}/included_asset_groups/{assetGroupId} operations: - name: removeincludedassetgroup method: DELETE description: Site Included Asset Group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: assetGroupId in: path type: integer description: The identifier of the asset group. required: true - name: api-3-sites-id-included-targets path: /api/3/sites/{id}/included_targets operations: - name: getincludedtargets method: GET description: Site Included Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: addincludedtargets method: POST description: Site Included Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: scanTargetsToAdd in: body type: array description: List of addresses to add to the site's included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. - name: body in: body type: object description: Request body (JSON). required: true - name: updateincludedtargets method: PUT description: Site Included Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanTargets in: body type: array description: List of addresses to be the site's new included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: removeincludedtargets method: DELETE description: Site Included Targets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: scanTargetsToRemove in: body type: array description: List of address to remove from the sites included scan targets. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. - name: api-3-sites-id-organization path: /api/3/sites/{id}/organization operations: - name: getsiteorganization method: GET description: Site Organization Information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: updatesiteorganization method: PUT description: Site Organization Information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: siteOrganization in: body type: string description: Resource for updating the specified site's organization information. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-scan-engine path: /api/3/sites/{id}/scan_engine operations: - name: getsitescanengine method: GET description: Site Scan Engine outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: setsitescanengine method: PUT description: Site Scan Engine outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanEngineId in: body type: integer description: The identifier of the scan engine. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-scan-schedules path: /api/3/sites/{id}/scan_schedules operations: - name: getsitescanschedules method: GET description: Site Scan Schedules outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: createsitescanschedule method: POST description: Site Scan Schedules outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanSchedule in: body type: string description: Resource for a scan schedule. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: setsitescanschedules method: PUT description: Site Scan Schedules outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanSchedules in: body type: array description: Array of resources for updating all scan schedules defined in the site. Scan schedules defined in the site that are omitted from this request will be deleted from the site. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deleteallsitescanschedules method: DELETE description: Site Scan Schedules outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-scan-schedules-scheduleid path: /api/3/sites/{id}/scan_schedules/{scheduleId} operations: - name: getsitescanschedule method: GET description: Site Scan Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: scheduleId in: path type: integer description: The identifier of the scan schedule. required: true - name: updatesitescanschedule method: PUT description: Site Scan Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanSchedule in: body type: string description: Resource for updating the specified scan schedule. - name: id in: path type: integer description: The identifier of the site. required: true - name: scheduleId in: path type: integer description: The identifier of the scan schedule. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: deletesitescanschedule method: DELETE description: Site Scan Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: scheduleId in: path type: integer description: The identifier of the scan schedule. required: true - name: api-3-sites-id-scan-template path: /api/3/sites/{id}/scan_template operations: - name: getsitescantemplate method: GET description: Site Scan Template outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: setsitescantemplate method: PUT description: Site Scan Template outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: scanTemplateId in: body type: string description: The identifier of the scan template. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-shared-credentials path: /api/3/sites/{id}/shared_credentials operations: - name: getsitesharedcredentials method: GET description: Assigned Shared Credentials outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-shared-credentials-credentialid-enabled path: /api/3/sites/{id}/shared_credentials/{credentialId}/enabled operations: - name: enablesharedcredentialonsite method: PUT description: Assigned Shared Credential Enablement outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: body type: boolean description: Flag indicating whether the shared credential is enabled for the site's scans. - name: id in: path type: integer description: The identifier of the site. required: true - name: credentialId in: path type: integer description: The identifier of the shared credential. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-site-credentials path: /api/3/sites/{id}/site_credentials operations: - name: getsitecredentials method: GET description: Site Scan Credentials outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: createsitecredential method: POST description: Site Scan Credentials outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: siteCredential in: body type: string description: The specification of a site credential. - name: body in: body type: object description: Request body (JSON). required: true - name: setsitecredentials method: PUT description: Site Scan Credentials outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: siteCredentials in: body type: array description: A list of site credentials resources. - name: body in: body type: object description: Request body (JSON). required: false - name: deleteallsitecredentials method: DELETE description: Site Scan Credentials outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-site-credentials-credentialid path: /api/3/sites/{id}/site_credentials/{credentialId} operations: - name: getsitecredential method: GET description: Site Scan Credential outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: credentialId in: path type: integer description: The identifier of the site credential. required: true - name: updatesitecredential method: PUT description: Site Scan Credential outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: credentialId in: path type: integer description: The identifier of the site credential. required: true - name: siteCredential in: body type: string description: The specification of the site credential to update. - name: body in: body type: object description: Request body (JSON). required: false - name: deletesitecredential method: DELETE description: Site Scan Credential outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: credentialId in: path type: integer description: The identifier of the site credential. required: true - name: api-3-sites-id-site-credentials-credentialid-enabled path: /api/3/sites/{id}/site_credentials/{credentialId}/enabled operations: - name: enablesitecredential method: PUT description: Site Credential Enablement outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: status in: body type: boolean description: Flag indicating whether the credential is enabled for use during the scan. - name: id in: path type: integer description: The identifier of the site. required: true - name: credentialId in: path type: integer description: The identifier of the site credential. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-tags path: /api/3/sites/{id}/tags operations: - name: getsitetags method: GET description: Site Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: setsitetags method: PUT description: Site Tags outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: tags in: body type: array description: A list of tag identifiers to replace the site's tags. - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-tags-tagid path: /api/3/sites/{id}/tags/{tagId} operations: - name: addsitetag method: PUT description: Site Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: tagId in: path type: integer description: The identifier of the tag. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: removesitetag method: DELETE description: Site Tag outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: tagId in: path type: integer description: The identifier of the tag. required: true - name: api-3-sites-id-users path: /api/3/sites/{id}/users operations: - name: getsiteusers method: GET description: Site Users Access outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: addsiteuser method: POST description: Site Users Access outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: param0 in: body type: integer description: The identifier of the user. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: setsiteusers method: PUT description: Site Users Access outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: users in: body type: array description: A list of user identifiers to replace the site's access list. - name: id in: path type: integer description: The identifier of the site. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: api-3-sites-id-users-userid path: /api/3/sites/{id}/users/{userId} operations: - name: removesiteuser method: DELETE description: Site User Access outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: userId in: path type: integer description: The identifier of the user. required: true - name: api-3-sites-id-web-authentication-html-forms path: /api/3/sites/{id}/web_authentication/html_forms operations: - name: getwebauthhtmlforms method: GET description: Web Authentication HTML Forms outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true - name: api-3-sites-id-web-authentication-http-headers path: /api/3/sites/{id}/web_authentication/http_headers operations: - name: getwebauthhttpheaders method: GET description: Web Authentication HTTP Headers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: The identifier of the site. required: true exposes: - type: rest namespace: insightvm-console-swagger-site-rest port: 8080 description: REST adapter for InsightVM API — Site. One resource per consumed operation, prefixed with /v1. resources: - path: /v1/api/3/sites/{id}/assets name: api-3-sites-id-assets description: REST surface for api-3-sites-id-assets. operations: - method: GET name: getsiteassets description: Site Assets call: insightvm-console-swagger-site.getsiteassets with: id: rest.id page: rest.page size: rest.size sort: rest.sort outputParameters: - type: object mapping: $. - method: DELETE name: removesiteassets description: Site Assets call: insightvm-console-swagger-site.removesiteassets with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites name: api-3-sites description: REST surface for api-3-sites. operations: - method: GET name: getsites description: Sites call: insightvm-console-swagger-site.getsites with: page: rest.page size: rest.size sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createsite description: Sites call: insightvm-console-swagger-site.createsite with: site: rest.site body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id} name: api-3-sites-id description: REST surface for api-3-sites-id. operations: - method: GET name: getsite description: Site call: insightvm-console-swagger-site.getsite with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: updatesite description: Site call: insightvm-console-swagger-site.updatesite with: site: rest.site id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesite description: Site call: insightvm-console-swagger-site.deletesite with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts name: api-3-sites-id-alerts description: REST surface for api-3-sites-id-alerts. operations: - method: GET name: getsitealerts description: Site Alerts call: insightvm-console-swagger-site.getsitealerts with: id: rest.id outputParameters: - type: object mapping: $. - method: DELETE name: deleteallsitealerts description: Site Alerts call: insightvm-console-swagger-site.deleteallsitealerts with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts/smtp name: api-3-sites-id-alerts-smtp description: REST surface for api-3-sites-id-alerts-smtp. operations: - method: GET name: getsitesmtpalerts description: Site SMTP Alerts call: insightvm-console-swagger-site.getsitesmtpalerts with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: createsitesmtpalert description: Site SMTP Alerts call: insightvm-console-swagger-site.createsitesmtpalert with: alert: rest.alert id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: setsitesmtpalerts description: Site SMTP Alerts call: insightvm-console-swagger-site.setsitesmtpalerts with: alert: rest.alert id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteallsitesmtpalerts description: Site SMTP Alerts call: insightvm-console-swagger-site.deleteallsitesmtpalerts with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts/smtp/{alertId} name: api-3-sites-id-alerts-smtp-alertid description: REST surface for api-3-sites-id-alerts-smtp-alertid. operations: - method: GET name: getsitesmtpalert description: Site SMTP Alert call: insightvm-console-swagger-site.getsitesmtpalert with: id: rest.id alertId: rest.alertId outputParameters: - type: object mapping: $. - method: PUT name: updatesitesmtpalert description: Site SMTP Alert call: insightvm-console-swagger-site.updatesitesmtpalert with: alert: rest.alert id: rest.id alertId: rest.alertId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesitesmtpalert description: Site SMTP Alert call: insightvm-console-swagger-site.deletesitesmtpalert with: id: rest.id alertId: rest.alertId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts/snmp name: api-3-sites-id-alerts-snmp description: REST surface for api-3-sites-id-alerts-snmp. operations: - method: GET name: getsitesnmpalerts description: Site SNMP Alerts call: insightvm-console-swagger-site.getsitesnmpalerts with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: createsitesnmpalert description: Site SNMP Alerts call: insightvm-console-swagger-site.createsitesnmpalert with: alert: rest.alert id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: setsitesnmpalerts description: Site SNMP Alerts call: insightvm-console-swagger-site.setsitesnmpalerts with: alert: rest.alert id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteallsitesnmpalerts description: Site SNMP Alerts call: insightvm-console-swagger-site.deleteallsitesnmpalerts with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts/snmp/{alertId} name: api-3-sites-id-alerts-snmp-alertid description: REST surface for api-3-sites-id-alerts-snmp-alertid. operations: - method: GET name: getsitesnmpalert description: Site SNMP Alert call: insightvm-console-swagger-site.getsitesnmpalert with: id: rest.id alertId: rest.alertId outputParameters: - type: object mapping: $. - method: PUT name: updatesitesnmpalert description: Site SNMP Alert call: insightvm-console-swagger-site.updatesitesnmpalert with: alert: rest.alert id: rest.id alertId: rest.alertId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesitesnmpalert description: Site SNMP Alert call: insightvm-console-swagger-site.deletesitesnmpalert with: id: rest.id alertId: rest.alertId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts/syslog name: api-3-sites-id-alerts-syslog description: REST surface for api-3-sites-id-alerts-syslog. operations: - method: GET name: getsitesyslogalerts description: Site Syslog Alerts call: insightvm-console-swagger-site.getsitesyslogalerts with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: createsitesyslogalert description: Site Syslog Alerts call: insightvm-console-swagger-site.createsitesyslogalert with: alert: rest.alert id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: setsitesyslogalerts description: Site Syslog Alerts call: insightvm-console-swagger-site.setsitesyslogalerts with: alert: rest.alert id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteallsitesyslogalerts description: Site Syslog Alerts call: insightvm-console-swagger-site.deleteallsitesyslogalerts with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/alerts/syslog/{alertId} name: api-3-sites-id-alerts-syslog-alertid description: REST surface for api-3-sites-id-alerts-syslog-alertid. operations: - method: GET name: getsitesyslogalert description: Site Syslog Alert call: insightvm-console-swagger-site.getsitesyslogalert with: id: rest.id alertId: rest.alertId outputParameters: - type: object mapping: $. - method: PUT name: updatesitesyslogalert description: Site Syslog Alert call: insightvm-console-swagger-site.updatesitesyslogalert with: alert: rest.alert id: rest.id alertId: rest.alertId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesitesyslogalert description: Site Syslog Alert call: insightvm-console-swagger-site.deletesitesyslogalert with: id: rest.id alertId: rest.alertId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/assets/{assetId} name: api-3-sites-id-assets-assetid description: REST surface for api-3-sites-id-assets-assetid. operations: - method: DELETE name: removeassetfromsite description: Site Asset call: insightvm-console-swagger-site.removeassetfromsite with: id: rest.id assetId: rest.assetId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/discovery_connection name: api-3-sites-id-discovery-connection description: REST surface for api-3-sites-id-discovery-connection. operations: - method: GET name: getsitediscoveryconnection description: Site Discovery Connection call: insightvm-console-swagger-site.getsitediscoveryconnection with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: setsitediscoveryconnection description: Site Discovery Connection call: insightvm-console-swagger-site.setsitediscoveryconnection with: connectionId: rest.connectionId id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/discovery_search_criteria name: api-3-sites-id-discovery-search-criteria description: REST surface for api-3-sites-id-discovery-search-criteria. operations: - method: GET name: getsitediscoverysearchcriteria description: Site Discovery Search Criteria call: insightvm-console-swagger-site.getsitediscoverysearchcriteria with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: setsitediscoverysearchcriteria description: Site Discovery Search Criteria call: insightvm-console-swagger-site.setsitediscoverysearchcriteria with: id: rest.id param1: rest.param1 body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/excluded_asset_groups name: api-3-sites-id-excluded-asset-groups description: REST surface for api-3-sites-id-excluded-asset-groups. operations: - method: GET name: getexcludedassetgroups description: Site Excluded Asset Groups call: insightvm-console-swagger-site.getexcludedassetgroups with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: updateexcludedassetgroups description: Site Excluded Asset Groups call: insightvm-console-swagger-site.updateexcludedassetgroups with: assetGroupIds: rest.assetGroupIds id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: removeallexcludedassetgroups description: Site Excluded Asset Groups call: insightvm-console-swagger-site.removeallexcludedassetgroups with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/excluded_asset_groups/{assetGroupId} name: api-3-sites-id-excluded-asset-groups-assetgroupid description: REST surface for api-3-sites-id-excluded-asset-groups-assetgroupid. operations: - method: DELETE name: removeexcludedassetgroup description: Site Excluded Asset Group call: insightvm-console-swagger-site.removeexcludedassetgroup with: id: rest.id assetGroupId: rest.assetGroupId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/excluded_targets name: api-3-sites-id-excluded-targets description: REST surface for api-3-sites-id-excluded-targets. operations: - method: GET name: getexcludedtargets description: Site Excluded Targets call: insightvm-console-swagger-site.getexcludedtargets with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: addexcludedtargets description: Site Excluded Targets call: insightvm-console-swagger-site.addexcludedtargets with: id: rest.id scanTargetsToAdd: rest.scanTargetsToAdd body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updateexcludedtargets description: Site Excluded Targets call: insightvm-console-swagger-site.updateexcludedtargets with: scanTargets: rest.scanTargets id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: removeexcludedtargets description: Site Excluded Targets call: insightvm-console-swagger-site.removeexcludedtargets with: id: rest.id scanTargetsToRemove: rest.scanTargetsToRemove outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/included_asset_groups name: api-3-sites-id-included-asset-groups description: REST surface for api-3-sites-id-included-asset-groups. operations: - method: GET name: getincludedassetgroups description: Site Included Asset Groups call: insightvm-console-swagger-site.getincludedassetgroups with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: updateincludedassetgroups description: Site Included Asset Groups call: insightvm-console-swagger-site.updateincludedassetgroups with: assetGroupIds: rest.assetGroupIds id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: removeallincludedassetgroups description: Site Included Asset Groups call: insightvm-console-swagger-site.removeallincludedassetgroups with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/included_asset_groups/{assetGroupId} name: api-3-sites-id-included-asset-groups-assetgroupid description: REST surface for api-3-sites-id-included-asset-groups-assetgroupid. operations: - method: DELETE name: removeincludedassetgroup description: Site Included Asset Group call: insightvm-console-swagger-site.removeincludedassetgroup with: id: rest.id assetGroupId: rest.assetGroupId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/included_targets name: api-3-sites-id-included-targets description: REST surface for api-3-sites-id-included-targets. operations: - method: GET name: getincludedtargets description: Site Included Targets call: insightvm-console-swagger-site.getincludedtargets with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: addincludedtargets description: Site Included Targets call: insightvm-console-swagger-site.addincludedtargets with: id: rest.id scanTargetsToAdd: rest.scanTargetsToAdd body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updateincludedtargets description: Site Included Targets call: insightvm-console-swagger-site.updateincludedtargets with: scanTargets: rest.scanTargets id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: removeincludedtargets description: Site Included Targets call: insightvm-console-swagger-site.removeincludedtargets with: id: rest.id scanTargetsToRemove: rest.scanTargetsToRemove outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/organization name: api-3-sites-id-organization description: REST surface for api-3-sites-id-organization. operations: - method: GET name: getsiteorganization description: Site Organization Information call: insightvm-console-swagger-site.getsiteorganization with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: updatesiteorganization description: Site Organization Information call: insightvm-console-swagger-site.updatesiteorganization with: siteOrganization: rest.siteOrganization id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/scan_engine name: api-3-sites-id-scan-engine description: REST surface for api-3-sites-id-scan-engine. operations: - method: GET name: getsitescanengine description: Site Scan Engine call: insightvm-console-swagger-site.getsitescanengine with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: setsitescanengine description: Site Scan Engine call: insightvm-console-swagger-site.setsitescanengine with: scanEngineId: rest.scanEngineId id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/scan_schedules name: api-3-sites-id-scan-schedules description: REST surface for api-3-sites-id-scan-schedules. operations: - method: GET name: getsitescanschedules description: Site Scan Schedules call: insightvm-console-swagger-site.getsitescanschedules with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: createsitescanschedule description: Site Scan Schedules call: insightvm-console-swagger-site.createsitescanschedule with: scanSchedule: rest.scanSchedule id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: setsitescanschedules description: Site Scan Schedules call: insightvm-console-swagger-site.setsitescanschedules with: scanSchedules: rest.scanSchedules id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteallsitescanschedules description: Site Scan Schedules call: insightvm-console-swagger-site.deleteallsitescanschedules with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/scan_schedules/{scheduleId} name: api-3-sites-id-scan-schedules-scheduleid description: REST surface for api-3-sites-id-scan-schedules-scheduleid. operations: - method: GET name: getsitescanschedule description: Site Scan Schedule call: insightvm-console-swagger-site.getsitescanschedule with: id: rest.id scheduleId: rest.scheduleId outputParameters: - type: object mapping: $. - method: PUT name: updatesitescanschedule description: Site Scan Schedule call: insightvm-console-swagger-site.updatesitescanschedule with: scanSchedule: rest.scanSchedule id: rest.id scheduleId: rest.scheduleId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesitescanschedule description: Site Scan Schedule call: insightvm-console-swagger-site.deletesitescanschedule with: id: rest.id scheduleId: rest.scheduleId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/scan_template name: api-3-sites-id-scan-template description: REST surface for api-3-sites-id-scan-template. operations: - method: GET name: getsitescantemplate description: Site Scan Template call: insightvm-console-swagger-site.getsitescantemplate with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: setsitescantemplate description: Site Scan Template call: insightvm-console-swagger-site.setsitescantemplate with: scanTemplateId: rest.scanTemplateId id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/shared_credentials name: api-3-sites-id-shared-credentials description: REST surface for api-3-sites-id-shared-credentials. operations: - method: GET name: getsitesharedcredentials description: Assigned Shared Credentials call: insightvm-console-swagger-site.getsitesharedcredentials with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/shared_credentials/{credentialId}/enabled name: api-3-sites-id-shared-credentials-credentialid-enabled description: REST surface for api-3-sites-id-shared-credentials-credentialid-enabled. operations: - method: PUT name: enablesharedcredentialonsite description: Assigned Shared Credential Enablement call: insightvm-console-swagger-site.enablesharedcredentialonsite with: status: rest.status id: rest.id credentialId: rest.credentialId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/site_credentials name: api-3-sites-id-site-credentials description: REST surface for api-3-sites-id-site-credentials. operations: - method: GET name: getsitecredentials description: Site Scan Credentials call: insightvm-console-swagger-site.getsitecredentials with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: createsitecredential description: Site Scan Credentials call: insightvm-console-swagger-site.createsitecredential with: id: rest.id siteCredential: rest.siteCredential body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: setsitecredentials description: Site Scan Credentials call: insightvm-console-swagger-site.setsitecredentials with: id: rest.id siteCredentials: rest.siteCredentials body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteallsitecredentials description: Site Scan Credentials call: insightvm-console-swagger-site.deleteallsitecredentials with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/site_credentials/{credentialId} name: api-3-sites-id-site-credentials-credentialid description: REST surface for api-3-sites-id-site-credentials-credentialid. operations: - method: GET name: getsitecredential description: Site Scan Credential call: insightvm-console-swagger-site.getsitecredential with: id: rest.id credentialId: rest.credentialId outputParameters: - type: object mapping: $. - method: PUT name: updatesitecredential description: Site Scan Credential call: insightvm-console-swagger-site.updatesitecredential with: id: rest.id credentialId: rest.credentialId siteCredential: rest.siteCredential body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletesitecredential description: Site Scan Credential call: insightvm-console-swagger-site.deletesitecredential with: id: rest.id credentialId: rest.credentialId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/site_credentials/{credentialId}/enabled name: api-3-sites-id-site-credentials-credentialid-enabled description: REST surface for api-3-sites-id-site-credentials-credentialid-enabled. operations: - method: PUT name: enablesitecredential description: Site Credential Enablement call: insightvm-console-swagger-site.enablesitecredential with: status: rest.status id: rest.id credentialId: rest.credentialId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/tags name: api-3-sites-id-tags description: REST surface for api-3-sites-id-tags. operations: - method: GET name: getsitetags description: Site Tags call: insightvm-console-swagger-site.getsitetags with: id: rest.id outputParameters: - type: object mapping: $. - method: PUT name: setsitetags description: Site Tags call: insightvm-console-swagger-site.setsitetags with: id: rest.id tags: rest.tags body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/tags/{tagId} name: api-3-sites-id-tags-tagid description: REST surface for api-3-sites-id-tags-tagid. operations: - method: PUT name: addsitetag description: Site Tag call: insightvm-console-swagger-site.addsitetag with: id: rest.id tagId: rest.tagId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: removesitetag description: Site Tag call: insightvm-console-swagger-site.removesitetag with: id: rest.id tagId: rest.tagId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/users name: api-3-sites-id-users description: REST surface for api-3-sites-id-users. operations: - method: GET name: getsiteusers description: Site Users Access call: insightvm-console-swagger-site.getsiteusers with: id: rest.id outputParameters: - type: object mapping: $. - method: POST name: addsiteuser description: Site Users Access call: insightvm-console-swagger-site.addsiteuser with: param0: rest.param0 id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: setsiteusers description: Site Users Access call: insightvm-console-swagger-site.setsiteusers with: users: rest.users id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/users/{userId} name: api-3-sites-id-users-userid description: REST surface for api-3-sites-id-users-userid. operations: - method: DELETE name: removesiteuser description: Site User Access call: insightvm-console-swagger-site.removesiteuser with: id: rest.id userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/web_authentication/html_forms name: api-3-sites-id-web-authentication-html-forms description: REST surface for api-3-sites-id-web-authentication-html-forms. operations: - method: GET name: getwebauthhtmlforms description: Web Authentication HTML Forms call: insightvm-console-swagger-site.getwebauthhtmlforms with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/api/3/sites/{id}/web_authentication/http_headers name: api-3-sites-id-web-authentication-http-headers description: REST surface for api-3-sites-id-web-authentication-http-headers. operations: - method: GET name: getwebauthhttpheaders description: Web Authentication HTTP Headers call: insightvm-console-swagger-site.getwebauthhttpheaders with: id: rest.id outputParameters: - type: object mapping: $. - type: mcp namespace: insightvm-console-swagger-site-mcp port: 9090 transport: http description: MCP adapter for InsightVM API — Site. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: rapid7-getsiteassets description: Site Assets hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsiteassets with: id: tools.id page: tools.page size: tools.size sort: tools.sort outputParameters: - type: object mapping: $. - name: rapid7-removesiteassets description: Site Assets hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removesiteassets with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsites description: Sites hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsites with: page: tools.page size: tools.size sort: tools.sort outputParameters: - type: object mapping: $. - name: rapid7-createsite description: Sites hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.createsite with: site: tools.site body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsite description: Site hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsite with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-updatesite description: Site hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesite with: site: tools.site id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deletesite description: Site hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deletesite with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitealerts description: Site Alerts hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitealerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-deleteallsitealerts description: Site Alerts hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deleteallsitealerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitesmtpalerts description: Site SMTP Alerts hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesmtpalerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-createsitesmtpalert description: Site SMTP Alerts hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.createsitesmtpalert with: alert: tools.alert id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-setsitesmtpalerts description: Site SMTP Alerts hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitesmtpalerts with: alert: tools.alert id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deleteallsitesmtpalerts description: Site SMTP Alerts hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deleteallsitesmtpalerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitesmtpalert description: Site SMTP Alert hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesmtpalert with: id: tools.id alertId: tools.alertId outputParameters: - type: object mapping: $. - name: rapid7-updatesitesmtpalert description: Site SMTP Alert hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesitesmtpalert with: alert: tools.alert id: tools.id alertId: tools.alertId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deletesitesmtpalert description: Site SMTP Alert hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deletesitesmtpalert with: id: tools.id alertId: tools.alertId outputParameters: - type: object mapping: $. - name: rapid7-getsitesnmpalerts description: Site SNMP Alerts hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesnmpalerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-createsitesnmpalert description: Site SNMP Alerts hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.createsitesnmpalert with: alert: tools.alert id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-setsitesnmpalerts description: Site SNMP Alerts hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitesnmpalerts with: alert: tools.alert id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deleteallsitesnmpalerts description: Site SNMP Alerts hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deleteallsitesnmpalerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitesnmpalert description: Site SNMP Alert hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesnmpalert with: id: tools.id alertId: tools.alertId outputParameters: - type: object mapping: $. - name: rapid7-updatesitesnmpalert description: Site SNMP Alert hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesitesnmpalert with: alert: tools.alert id: tools.id alertId: tools.alertId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deletesitesnmpalert description: Site SNMP Alert hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deletesitesnmpalert with: id: tools.id alertId: tools.alertId outputParameters: - type: object mapping: $. - name: rapid7-getsitesyslogalerts description: Site Syslog Alerts hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesyslogalerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-createsitesyslogalert description: Site Syslog Alerts hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.createsitesyslogalert with: alert: tools.alert id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-setsitesyslogalerts description: Site Syslog Alerts hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitesyslogalerts with: alert: tools.alert id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deleteallsitesyslogalerts description: Site Syslog Alerts hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deleteallsitesyslogalerts with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitesyslogalert description: Site Syslog Alert hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesyslogalert with: id: tools.id alertId: tools.alertId outputParameters: - type: object mapping: $. - name: rapid7-updatesitesyslogalert description: Site Syslog Alert hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesitesyslogalert with: alert: tools.alert id: tools.id alertId: tools.alertId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deletesitesyslogalert description: Site Syslog Alert hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deletesitesyslogalert with: id: tools.id alertId: tools.alertId outputParameters: - type: object mapping: $. - name: rapid7-removeassetfromsite description: Site Asset hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeassetfromsite with: id: tools.id assetId: tools.assetId outputParameters: - type: object mapping: $. - name: rapid7-getsitediscoveryconnection description: Site Discovery Connection hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitediscoveryconnection with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-setsitediscoveryconnection description: Site Discovery Connection hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitediscoveryconnection with: connectionId: tools.connectionId id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsitediscoverysearchcriteria description: Site Discovery Search Criteria hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitediscoverysearchcriteria with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-setsitediscoverysearchcriteria description: Site Discovery Search Criteria hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitediscoverysearchcriteria with: id: tools.id param1: tools.param1 body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getexcludedassetgroups description: Site Excluded Asset Groups hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getexcludedassetgroups with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-updateexcludedassetgroups description: Site Excluded Asset Groups hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updateexcludedassetgroups with: assetGroupIds: tools.assetGroupIds id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-removeallexcludedassetgroups description: Site Excluded Asset Groups hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeallexcludedassetgroups with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-removeexcludedassetgroup description: Site Excluded Asset Group hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeexcludedassetgroup with: id: tools.id assetGroupId: tools.assetGroupId outputParameters: - type: object mapping: $. - name: rapid7-getexcludedtargets description: Site Excluded Targets hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getexcludedtargets with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-addexcludedtargets description: Site Excluded Targets hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.addexcludedtargets with: id: tools.id scanTargetsToAdd: tools.scanTargetsToAdd body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-updateexcludedtargets description: Site Excluded Targets hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updateexcludedtargets with: scanTargets: tools.scanTargets id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-removeexcludedtargets description: Site Excluded Targets hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeexcludedtargets with: id: tools.id scanTargetsToRemove: tools.scanTargetsToRemove outputParameters: - type: object mapping: $. - name: rapid7-getincludedassetgroups description: Site Included Asset Groups hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getincludedassetgroups with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-updateincludedassetgroups description: Site Included Asset Groups hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updateincludedassetgroups with: assetGroupIds: tools.assetGroupIds id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-removeallincludedassetgroups description: Site Included Asset Groups hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeallincludedassetgroups with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-removeincludedassetgroup description: Site Included Asset Group hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeincludedassetgroup with: id: tools.id assetGroupId: tools.assetGroupId outputParameters: - type: object mapping: $. - name: rapid7-getincludedtargets description: Site Included Targets hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getincludedtargets with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-addincludedtargets description: Site Included Targets hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.addincludedtargets with: id: tools.id scanTargetsToAdd: tools.scanTargetsToAdd body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-updateincludedtargets description: Site Included Targets hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updateincludedtargets with: scanTargets: tools.scanTargets id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-removeincludedtargets description: Site Included Targets hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removeincludedtargets with: id: tools.id scanTargetsToRemove: tools.scanTargetsToRemove outputParameters: - type: object mapping: $. - name: rapid7-getsiteorganization description: Site Organization Information hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsiteorganization with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-updatesiteorganization description: Site Organization Information hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesiteorganization with: siteOrganization: tools.siteOrganization id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsitescanengine description: Site Scan Engine hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitescanengine with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-setsitescanengine description: Site Scan Engine hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitescanengine with: scanEngineId: tools.scanEngineId id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsitescanschedules description: Site Scan Schedules hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitescanschedules with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-createsitescanschedule description: Site Scan Schedules hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.createsitescanschedule with: scanSchedule: tools.scanSchedule id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-setsitescanschedules description: Site Scan Schedules hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitescanschedules with: scanSchedules: tools.scanSchedules id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deleteallsitescanschedules description: Site Scan Schedules hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deleteallsitescanschedules with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitescanschedule description: Site Scan Schedule hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitescanschedule with: id: tools.id scheduleId: tools.scheduleId outputParameters: - type: object mapping: $. - name: rapid7-updatesitescanschedule description: Site Scan Schedule hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesitescanschedule with: scanSchedule: tools.scanSchedule id: tools.id scheduleId: tools.scheduleId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deletesitescanschedule description: Site Scan Schedule hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deletesitescanschedule with: id: tools.id scheduleId: tools.scheduleId outputParameters: - type: object mapping: $. - name: rapid7-getsitescantemplate description: Site Scan Template hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitescantemplate with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-setsitescantemplate description: Site Scan Template hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitescantemplate with: scanTemplateId: tools.scanTemplateId id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsitesharedcredentials description: Assigned Shared Credentials hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitesharedcredentials with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-enablesharedcredentialonsite description: Assigned Shared Credential Enablement hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.enablesharedcredentialonsite with: status: tools.status id: tools.id credentialId: tools.credentialId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsitecredentials description: Site Scan Credentials hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitecredentials with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-createsitecredential description: Site Scan Credentials hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.createsitecredential with: id: tools.id siteCredential: tools.siteCredential body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-setsitecredentials description: Site Scan Credentials hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitecredentials with: id: tools.id siteCredentials: tools.siteCredentials body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deleteallsitecredentials description: Site Scan Credentials hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deleteallsitecredentials with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getsitecredential description: Site Scan Credential hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitecredential with: id: tools.id credentialId: tools.credentialId outputParameters: - type: object mapping: $. - name: rapid7-updatesitecredential description: Site Scan Credential hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.updatesitecredential with: id: tools.id credentialId: tools.credentialId siteCredential: tools.siteCredential body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-deletesitecredential description: Site Scan Credential hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.deletesitecredential with: id: tools.id credentialId: tools.credentialId outputParameters: - type: object mapping: $. - name: rapid7-enablesitecredential description: Site Credential Enablement hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.enablesitecredential with: status: tools.status id: tools.id credentialId: tools.credentialId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-getsitetags description: Site Tags hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsitetags with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-setsitetags description: Site Tags hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsitetags with: id: tools.id tags: tools.tags body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-addsitetag description: Site Tag hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.addsitetag with: id: tools.id tagId: tools.tagId body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-removesitetag description: Site Tag hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removesitetag with: id: tools.id tagId: tools.tagId outputParameters: - type: object mapping: $. - name: rapid7-getsiteusers description: Site Users Access hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getsiteusers with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-addsiteuser description: Site Users Access hints: readOnly: false destructive: false idempotent: false call: insightvm-console-swagger-site.addsiteuser with: param0: tools.param0 id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-setsiteusers description: Site Users Access hints: readOnly: false destructive: false idempotent: true call: insightvm-console-swagger-site.setsiteusers with: users: tools.users id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: rapid7-removesiteuser description: Site User Access hints: readOnly: false destructive: true idempotent: true call: insightvm-console-swagger-site.removesiteuser with: id: tools.id userId: tools.userId outputParameters: - type: object mapping: $. - name: rapid7-getwebauthhtmlforms description: Web Authentication HTML Forms hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getwebauthhtmlforms with: id: tools.id outputParameters: - type: object mapping: $. - name: rapid7-getwebauthhttpheaders description: Web Authentication HTTP Headers hints: readOnly: true destructive: false idempotent: true call: insightvm-console-swagger-site.getwebauthhttpheaders with: id: tools.id outputParameters: - type: object mapping: $.