├── .github ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── .rspec ├── .swagger-codegen-ignore ├── .swagger-codegen └── VERSION ├── Gemfile ├── LICENSE ├── README.md ├── Rakefile ├── api-files ├── api_history.json └── console-swagger.json ├── cortex.yaml ├── docs ├── Account.md ├── AdditionalInformation.md ├── Address.md ├── AdhocScan.md ├── AdministrationApi.md ├── AdvisoryLink.md ├── Alert.md ├── AssessmentResult.md ├── Asset.md ├── AssetApi.md ├── AssetCreate.md ├── AssetCreatedOrUpdatedReference.md ├── AssetDiscoveryApi.md ├── AssetGroup.md ├── AssetGroupApi.md ├── AssetHistory.md ├── AssetPolicy.md ├── AssetPolicyAssessment.md ├── AssetPolicyItem.md ├── AssetTag.md ├── AssetVulnerabilities.md ├── AuthenticationSettings.md ├── AuthenticationSource.md ├── AvailableReportFormat.md ├── BackupsSize.md ├── BadRequestError.md ├── CPUInfo.md ├── Configuration.md ├── ConsoleCommandOutput.md ├── ContentDescription.md ├── CreateAuthenticationSource.md ├── CreatedOrUpdatedReference.md ├── CreatedReference.md ├── CreatedReferenceAssetGroupIDLink.md ├── CreatedReferenceCredentialIDLink.md ├── CreatedReferenceDiscoveryQueryIDLink.md ├── CreatedReferenceEngineIDLink.md ├── CreatedReferencePolicyOverrideIDLink.md ├── CreatedReferenceScanIDLink.md ├── CreatedReferenceScanTemplateIDLink.md ├── CreatedReferenceUserIDLink.md ├── CreatedReferenceVulnerabilityExceptionIDLink.md ├── CreatedReferenceVulnerabilityValidationIDLink.md ├── CreatedReferenceintLink.md ├── CredentialApi.md ├── Criterion.md ├── Database.md ├── DatabaseConnectionSettings.md ├── DatabaseSettings.md ├── DatabaseSize.md ├── DiscoveryAsset.md ├── DiscoveryConnection.md ├── DiscoverySearchCriteria.md ├── DiskFree.md ├── DiskInfo.md ├── DiskTotal.md ├── DynamicSite.md ├── EnginePool.md ├── EnvironmentProperties.md ├── Error.md ├── ExceptionScope.md ├── ExcludedAssetGroups.md ├── ExcludedScanTargets.md ├── Exploit.md ├── ExploitSource.md ├── ExploitSourceLink.md ├── Features.md ├── File.md ├── Fingerprint.md ├── GlobalScan.md ├── GroupAccount.md ├── HostName.md ├── IMetaData.md ├── IncludedAssetGroups.md ├── IncludedScanTargets.md ├── Info.md ├── InstallSize.md ├── InstallationTotalSize.md ├── InternalServerError.md ├── JVMInfo.md ├── JsonNode.md ├── License.md ├── LicenseLimits.md ├── LicensePolicyScanning.md ├── LicensePolicyScanningBenchmarks.md ├── LicenseReporting.md ├── LicenseScanning.md ├── Link.md ├── Links.md ├── LocalePreferences.md ├── MalwareKit.md ├── MatchedSolution.md ├── MemoryFree.md ├── MemoryInfo.md ├── MemoryTotal.md ├── NotFoundError.md ├── OperatingSystem.md ├── OperatingSystemCpe.md ├── PCI.md ├── PageInfo.md ├── PageOfAsset.md ├── PageOfAssetGroup.md ├── PageOfAssetPolicy.md ├── PageOfAssetPolicyItem.md ├── PageOfDiscoveryConnection.md ├── PageOfExploit.md ├── PageOfGlobalScan.md ├── PageOfMalwareKit.md ├── PageOfOperatingSystem.md ├── PageOfPolicy.md ├── PageOfPolicyAsset.md ├── PageOfPolicyControl.md ├── PageOfPolicyGroup.md ├── PageOfPolicyItem.md ├── PageOfPolicyOverride.md ├── PageOfPolicyRule.md ├── PageOfReport.md ├── PageOfScan.md ├── PageOfSite.md ├── PageOfSoftware.md ├── PageOfTag.md ├── PageOfUser.md ├── PageOfVulnerability.md ├── PageOfVulnerabilityCategory.md ├── PageOfVulnerabilityCheck.md ├── PageOfVulnerabilityException.md ├── PageOfVulnerabilityFinding.md ├── PageOfVulnerabilityReference.md ├── Policy.md ├── PolicyApi.md ├── PolicyAsset.md ├── PolicyBenchmark.md ├── PolicyControl.md ├── PolicyGroup.md ├── PolicyItem.md ├── PolicyMetadataResource.md ├── PolicyOverride.md ├── PolicyOverrideApi.md ├── PolicyOverrideReviewer.md ├── PolicyOverrideScope.md ├── PolicyOverrideSubmitter.md ├── PolicyRule.md ├── PolicyRuleAssessmentResource.md ├── PolicySummaryResource.md ├── Privileges.md ├── RangeResource.md ├── ReferenceWithAlertIDLink.md ├── ReferenceWithAssetIDLink.md ├── ReferenceWithEndpointIDLink.md ├── ReferenceWithEngineIDLink.md ├── ReferenceWithReportIDLink.md ├── ReferenceWithScanScheduleIDLink.md ├── ReferenceWithSiteIDLink.md ├── ReferenceWithTagIDLink.md ├── ReferenceWithUserIDLink.md ├── ReferencesWithAssetGroupIDLink.md ├── ReferencesWithAssetIDLink.md ├── ReferencesWithEngineIDLink.md ├── ReferencesWithReferenceWithEndpointIDLinkServiceLink.md ├── ReferencesWithSiteIDLink.md ├── ReferencesWithSolutionNaturalIDLink.md ├── ReferencesWithTagIDLink.md ├── ReferencesWithUserIDLink.md ├── ReferencesWithVulnerabilityCheckIDLink.md ├── ReferencesWithVulnerabilityCheckTypeIDLink.md ├── ReferencesWithVulnerabilityNaturalIDLink.md ├── ReferencesWithWebApplicationIDLink.md ├── RemediationApi.md ├── RemediationResource.md ├── Repeat.md ├── Report.md ├── ReportApi.md ├── ReportConfigCategoryFilters.md ├── ReportConfigDatabaseCredentialsResource.md ├── ReportConfigDatabaseResource.md ├── ReportConfigFiltersResource.md ├── ReportConfigScopeResource.md ├── ReportEmail.md ├── ReportEmailSmtp.md ├── ReportFilters.md ├── ReportFrequency.md ├── ReportInstance.md ├── ReportRepeat.md ├── ReportScope.md ├── ReportSize.md ├── ReportStorage.md ├── ReportTemplate.md ├── ResourcesAlert.md ├── ResourcesAssetGroup.md ├── ResourcesAssetTag.md ├── ResourcesAuthenticationSource.md ├── ResourcesAvailableReportFormat.md ├── ResourcesConfiguration.md ├── ResourcesDatabase.md ├── ResourcesDiscoveryAsset.md ├── ResourcesEnginePool.md ├── ResourcesFile.md ├── ResourcesGroupAccount.md ├── ResourcesMatchedSolution.md ├── ResourcesPolicyOverride.md ├── ResourcesReportInstance.md ├── ResourcesReportTemplate.md ├── ResourcesRole.md ├── ResourcesScanEngine.md ├── ResourcesScanSchedule.md ├── ResourcesScanTemplate.md ├── ResourcesSharedCredential.md ├── ResourcesSiteCredential.md ├── ResourcesSiteSharedCredential.md ├── ResourcesSmtpAlert.md ├── ResourcesSnmpAlert.md ├── ResourcesSoftware.md ├── ResourcesSolution.md ├── ResourcesSonarQuery.md ├── ResourcesSyslogAlert.md ├── ResourcesTag.md ├── ResourcesUser.md ├── ResourcesUserAccount.md ├── ResourcesVulnerabilityValidationResource.md ├── ResourcesWebFormAuthentication.md ├── ResourcesWebHeaderAuthentication.md ├── Review.md ├── RiskModifierSettings.md ├── RiskSettings.md ├── RiskTrendAllAssetsResource.md ├── RiskTrendResource.md ├── Role.md ├── RootApi.md ├── Scan.md ├── ScanApi.md ├── ScanEngine.md ├── ScanEngineApi.md ├── ScanEvents.md ├── ScanSchedule.md ├── ScanScope.md ├── ScanSettings.md ├── ScanSize.md ├── ScanTargetsResource.md ├── ScanTemplate.md ├── ScanTemplateApi.md ├── ScanTemplateAssetDiscovery.md ├── ScanTemplateDatabase.md ├── ScanTemplateDiscovery.md ├── ScanTemplateDiscoveryPerformance.md ├── ScanTemplateDiscoveryPerformancePacketsRate.md ├── ScanTemplateDiscoveryPerformanceParallelism.md ├── ScanTemplateDiscoveryPerformanceScanDelay.md ├── ScanTemplateDiscoveryPerformanceTimeout.md ├── ScanTemplateServiceDiscovery.md ├── ScanTemplateServiceDiscoveryTcp.md ├── ScanTemplateServiceDiscoveryUdp.md ├── ScanTemplateVulnerabilityCheckCategories.md ├── ScanTemplateVulnerabilityCheckIndividual.md ├── ScanTemplateVulnerabilityChecks.md ├── ScanTemplateWebSpider.md ├── ScanTemplateWebSpiderPaths.md ├── ScanTemplateWebSpiderPatterns.md ├── ScanTemplateWebSpiderPerformance.md ├── ScheduledScanTargets.md ├── SearchCriteria.md ├── Service.md ├── ServiceLink.md ├── ServiceUnavailableError.md ├── Settings.md ├── SharedCredential.md ├── SharedCredentialAccount.md ├── Site.md ├── SiteApi.md ├── SiteCreateResource.md ├── SiteCredential.md ├── SiteDiscoveryConnection.md ├── SiteOrganization.md ├── SiteSharedCredential.md ├── SiteUpdateResource.md ├── SmtpAlert.md ├── SmtpSettings.md ├── SnmpAlert.md ├── Software.md ├── SoftwareCpe.md ├── Solution.md ├── SolutionMatch.md ├── SonarCriteria.md ├── SonarCriterion.md ├── SonarQuery.md ├── StaticSite.md ├── Steps.md ├── Submission.md ├── Summary.md ├── SwaggerDiscoverySearchCriteriaFilter.md ├── SwaggerSearchCriteriaFilter.md ├── SyslogAlert.md ├── Tag.md ├── TagApi.md ├── TagAssetSource.md ├── TagLink.md ├── TaggedAssetReferences.md ├── Telnet.md ├── TokenResource.md ├── UnauthorizedError.md ├── UniqueId.md ├── UpdateId.md ├── UpdateInfo.md ├── UpdateSettings.md ├── User.md ├── UserAccount.md ├── UserApi.md ├── UserCreateRole.md ├── UserEdit.md ├── UserRole.md ├── VersionInfo.md ├── Vulnerabilities.md ├── Vulnerability.md ├── VulnerabilityApi.md ├── VulnerabilityCategory.md ├── VulnerabilityCheck.md ├── VulnerabilityCheckApi.md ├── VulnerabilityCheckType.md ├── VulnerabilityCvss.md ├── VulnerabilityCvssV2.md ├── VulnerabilityCvssV3.md ├── VulnerabilityEvents.md ├── VulnerabilityException.md ├── VulnerabilityExceptionApi.md ├── VulnerabilityFinding.md ├── VulnerabilityReference.md ├── VulnerabilityResultApi.md ├── VulnerabilityValidationResource.md ├── VulnerabilityValidationSource.md ├── WebApplication.md ├── WebFormAuthentication.md ├── WebHeaderAuthentication.md ├── WebPage.md └── WebSettings.md ├── git_push.sh ├── lib ├── rapid7_vm_console.rb └── rapid7_vm_console │ ├── api │ ├── administration_api.rb │ ├── asset_api.rb │ ├── asset_discovery_api.rb │ ├── asset_group_api.rb │ ├── credential_api.rb │ ├── policy_api.rb │ ├── policy_override_api.rb │ ├── remediation_api.rb │ ├── report_api.rb │ ├── root_api.rb │ ├── scan_api.rb │ ├── scan_engine_api.rb │ ├── scan_template_api.rb │ ├── site_api.rb │ ├── tag_api.rb │ ├── user_api.rb │ ├── vulnerability_api.rb │ ├── vulnerability_check_api.rb │ ├── vulnerability_exception_api.rb │ └── vulnerability_result_api.rb │ ├── api_client.rb │ ├── api_error.rb │ ├── configuration.rb │ ├── models │ ├── account.rb │ ├── additional_information.rb │ ├── address.rb │ ├── adhoc_scan.rb │ ├── advisory_link.rb │ ├── alert.rb │ ├── assessment_result.rb │ ├── asset.rb │ ├── asset_create.rb │ ├── asset_created_or_updated_reference.rb │ ├── asset_group.rb │ ├── asset_history.rb │ ├── asset_policy.rb │ ├── asset_policy_assessment.rb │ ├── asset_policy_item.rb │ ├── asset_tag.rb │ ├── asset_vulnerabilities.rb │ ├── authentication_settings.rb │ ├── authentication_source.rb │ ├── available_report_format.rb │ ├── backups_size.rb │ ├── bad_request_error.rb │ ├── configuration.rb │ ├── console_command_output.rb │ ├── content_description.rb │ ├── cpu_info.rb │ ├── create_authentication_source.rb │ ├── created_or_updated_reference.rb │ ├── created_reference.rb │ ├── created_reference_asset_group_id_link.rb │ ├── created_reference_credential_id_link.rb │ ├── created_reference_discovery_query_id_link.rb │ ├── created_reference_engine_id_link.rb │ ├── created_reference_policy_override_id_link.rb │ ├── created_reference_scan_id_link.rb │ ├── created_reference_scan_template_id_link.rb │ ├── created_reference_user_id_link.rb │ ├── created_reference_vulnerability_exception_id_link.rb │ ├── created_reference_vulnerability_validation_id_link.rb │ ├── created_referenceint_link.rb │ ├── criterion.rb │ ├── database.rb │ ├── database_connection_settings.rb │ ├── database_settings.rb │ ├── database_size.rb │ ├── discovery_asset.rb │ ├── discovery_connection.rb │ ├── discovery_search_criteria.rb │ ├── disk_free.rb │ ├── disk_info.rb │ ├── disk_total.rb │ ├── dynamic_site.rb │ ├── engine_pool.rb │ ├── environment_properties.rb │ ├── error.rb │ ├── exception_scope.rb │ ├── excluded_asset_groups.rb │ ├── excluded_scan_targets.rb │ ├── exploit.rb │ ├── exploit_source.rb │ ├── exploit_source_link.rb │ ├── features.rb │ ├── file.rb │ ├── fingerprint.rb │ ├── global_scan.rb │ ├── group_account.rb │ ├── host_name.rb │ ├── i_meta_data.rb │ ├── included_asset_groups.rb │ ├── included_scan_targets.rb │ ├── info.rb │ ├── install_size.rb │ ├── installation_total_size.rb │ ├── internal_server_error.rb │ ├── json_node.rb │ ├── jvm_info.rb │ ├── license.rb │ ├── license_limits.rb │ ├── license_policy_scanning.rb │ ├── license_policy_scanning_benchmarks.rb │ ├── license_reporting.rb │ ├── license_scanning.rb │ ├── link.rb │ ├── links.rb │ ├── locale_preferences.rb │ ├── malware_kit.rb │ ├── matched_solution.rb │ ├── memory_free.rb │ ├── memory_info.rb │ ├── memory_total.rb │ ├── not_found_error.rb │ ├── operating_system.rb │ ├── operating_system_cpe.rb │ ├── page_info.rb │ ├── page_of_asset.rb │ ├── page_of_asset_group.rb │ ├── page_of_asset_policy.rb │ ├── page_of_asset_policy_item.rb │ ├── page_of_discovery_connection.rb │ ├── page_of_exploit.rb │ ├── page_of_global_scan.rb │ ├── page_of_malware_kit.rb │ ├── page_of_operating_system.rb │ ├── page_of_policy.rb │ ├── page_of_policy_asset.rb │ ├── page_of_policy_control.rb │ ├── page_of_policy_group.rb │ ├── page_of_policy_item.rb │ ├── page_of_policy_override.rb │ ├── page_of_policy_rule.rb │ ├── page_of_report.rb │ ├── page_of_scan.rb │ ├── page_of_site.rb │ ├── page_of_software.rb │ ├── page_of_tag.rb │ ├── page_of_user.rb │ ├── page_of_vulnerability.rb │ ├── page_of_vulnerability_category.rb │ ├── page_of_vulnerability_check.rb │ ├── page_of_vulnerability_exception.rb │ ├── page_of_vulnerability_finding.rb │ ├── page_of_vulnerability_reference.rb │ ├── pci.rb │ ├── policy.rb │ ├── policy_asset.rb │ ├── policy_benchmark.rb │ ├── policy_control.rb │ ├── policy_group.rb │ ├── policy_item.rb │ ├── policy_metadata_resource.rb │ ├── policy_override.rb │ ├── policy_override_reviewer.rb │ ├── policy_override_scope.rb │ ├── policy_override_submitter.rb │ ├── policy_rule.rb │ ├── policy_rule_assessment_resource.rb │ ├── policy_summary_resource.rb │ ├── privileges.rb │ ├── range_resource.rb │ ├── reference_with_alert_id_link.rb │ ├── reference_with_asset_id_link.rb │ ├── reference_with_endpoint_id_link.rb │ ├── reference_with_engine_id_link.rb │ ├── reference_with_report_id_link.rb │ ├── reference_with_scan_schedule_id_link.rb │ ├── reference_with_site_id_link.rb │ ├── reference_with_tag_id_link.rb │ ├── reference_with_user_id_link.rb │ ├── references_with_asset_group_id_link.rb │ ├── references_with_asset_id_link.rb │ ├── references_with_engine_id_link.rb │ ├── references_with_reference_with_endpoint_id_link_service_link.rb │ ├── references_with_site_id_link.rb │ ├── references_with_solution_natural_id_link.rb │ ├── references_with_tag_id_link.rb │ ├── references_with_user_id_link.rb │ ├── references_with_vulnerability_check_id_link.rb │ ├── references_with_vulnerability_check_type_id_link.rb │ ├── references_with_vulnerability_natural_id_link.rb │ ├── references_with_web_application_id_link.rb │ ├── remediation_resource.rb │ ├── repeat.rb │ ├── report.rb │ ├── report_config_category_filters.rb │ ├── report_config_database_credentials_resource.rb │ ├── report_config_database_resource.rb │ ├── report_config_filters_resource.rb │ ├── report_config_scope_resource.rb │ ├── report_email.rb │ ├── report_email_smtp.rb │ ├── report_filters.rb │ ├── report_frequency.rb │ ├── report_instance.rb │ ├── report_repeat.rb │ ├── report_scope.rb │ ├── report_size.rb │ ├── report_storage.rb │ ├── report_template.rb │ ├── resources_alert.rb │ ├── resources_asset_group.rb │ ├── resources_asset_tag.rb │ ├── resources_authentication_source.rb │ ├── resources_available_report_format.rb │ ├── resources_configuration.rb │ ├── resources_database.rb │ ├── resources_discovery_asset.rb │ ├── resources_engine_pool.rb │ ├── resources_file.rb │ ├── resources_group_account.rb │ ├── resources_matched_solution.rb │ ├── resources_policy_override.rb │ ├── resources_report_instance.rb │ ├── resources_report_template.rb │ ├── resources_role.rb │ ├── resources_scan_engine.rb │ ├── resources_scan_schedule.rb │ ├── resources_scan_template.rb │ ├── resources_shared_credential.rb │ ├── resources_site_credential.rb │ ├── resources_site_shared_credential.rb │ ├── resources_smtp_alert.rb │ ├── resources_snmp_alert.rb │ ├── resources_software.rb │ ├── resources_solution.rb │ ├── resources_sonar_query.rb │ ├── resources_syslog_alert.rb │ ├── resources_tag.rb │ ├── resources_user.rb │ ├── resources_user_account.rb │ ├── resources_vulnerability_validation_resource.rb │ ├── resources_web_form_authentication.rb │ ├── resources_web_header_authentication.rb │ ├── review.rb │ ├── risk_modifier_settings.rb │ ├── risk_settings.rb │ ├── risk_trend_all_assets_resource.rb │ ├── risk_trend_resource.rb │ ├── role.rb │ ├── scan.rb │ ├── scan_engine.rb │ ├── scan_events.rb │ ├── scan_schedule.rb │ ├── scan_scope.rb │ ├── scan_settings.rb │ ├── scan_size.rb │ ├── scan_targets_resource.rb │ ├── scan_template.rb │ ├── scan_template_asset_discovery.rb │ ├── scan_template_database.rb │ ├── scan_template_discovery.rb │ ├── scan_template_discovery_performance.rb │ ├── scan_template_discovery_performance_packets_rate.rb │ ├── scan_template_discovery_performance_parallelism.rb │ ├── scan_template_discovery_performance_scan_delay.rb │ ├── scan_template_discovery_performance_timeout.rb │ ├── scan_template_service_discovery.rb │ ├── scan_template_service_discovery_tcp.rb │ ├── scan_template_service_discovery_udp.rb │ ├── scan_template_vulnerability_check_categories.rb │ ├── scan_template_vulnerability_check_individual.rb │ ├── scan_template_vulnerability_checks.rb │ ├── scan_template_web_spider.rb │ ├── scan_template_web_spider_paths.rb │ ├── scan_template_web_spider_patterns.rb │ ├── scan_template_web_spider_performance.rb │ ├── scheduled_scan_targets.rb │ ├── search_criteria.rb │ ├── service.rb │ ├── service_link.rb │ ├── service_unavailable_error.rb │ ├── settings.rb │ ├── shared_credential.rb │ ├── shared_credential_account.rb │ ├── site.rb │ ├── site_create_resource.rb │ ├── site_credential.rb │ ├── site_discovery_connection.rb │ ├── site_organization.rb │ ├── site_shared_credential.rb │ ├── site_update_resource.rb │ ├── smtp_alert.rb │ ├── smtp_settings.rb │ ├── snmp_alert.rb │ ├── software.rb │ ├── software_cpe.rb │ ├── solution.rb │ ├── solution_match.rb │ ├── sonar_criteria.rb │ ├── sonar_criterion.rb │ ├── sonar_query.rb │ ├── static_site.rb │ ├── steps.rb │ ├── submission.rb │ ├── summary.rb │ ├── swagger_discovery_search_criteria_filter.rb │ ├── swagger_search_criteria_filter.rb │ ├── syslog_alert.rb │ ├── tag.rb │ ├── tag_asset_source.rb │ ├── tag_link.rb │ ├── tagged_asset_references.rb │ ├── telnet.rb │ ├── token_resource.rb │ ├── unauthorized_error.rb │ ├── unique_id.rb │ ├── update_id.rb │ ├── update_info.rb │ ├── update_settings.rb │ ├── user.rb │ ├── user_account.rb │ ├── user_create_role.rb │ ├── user_edit.rb │ ├── user_role.rb │ ├── version_info.rb │ ├── vulnerabilities.rb │ ├── vulnerability.rb │ ├── vulnerability_category.rb │ ├── vulnerability_check.rb │ ├── vulnerability_check_type.rb │ ├── vulnerability_cvss.rb │ ├── vulnerability_cvss_v2.rb │ ├── vulnerability_cvss_v3.rb │ ├── vulnerability_events.rb │ ├── vulnerability_exception.rb │ ├── vulnerability_finding.rb │ ├── vulnerability_reference.rb │ ├── vulnerability_validation_resource.rb │ ├── vulnerability_validation_source.rb │ ├── web_application.rb │ ├── web_form_authentication.rb │ ├── web_header_authentication.rb │ ├── web_page.rb │ └── web_settings.rb │ └── version.rb ├── rapid7_vm_console.gemspec ├── samples ├── credential │ ├── create_shared_credential.rb │ ├── list_shared_credentials.rb │ └── list_site_credentials.rb ├── report │ ├── create_sql_report.rb │ ├── list_reports.rb │ └── run_report.rb ├── scan │ └── list_site_scans.rb ├── settings.yml └── site │ ├── create_site.rb │ ├── create_site_schedule.rb │ ├── list_sites.rb │ ├── list_sites_schedules.rb │ └── scan_site.rb ├── setup_workspace ├── config.json ├── setup_workspace.sh └── swagger-codegen-cli-2.4.0.jar └── spec ├── api ├── administration_api_spec.rb ├── asset_api_spec.rb ├── asset_discovery_api_spec.rb ├── asset_group_api_spec.rb ├── credential_api_spec.rb ├── policy_api_spec.rb ├── policy_override_api_spec.rb ├── remediation_api_spec.rb ├── report_api_spec.rb ├── root_api_spec.rb ├── scan_api_spec.rb ├── scan_engine_api_spec.rb ├── scan_template_api_spec.rb ├── site_api_spec.rb ├── tag_api_spec.rb ├── user_api_spec.rb ├── vulnerability_api_spec.rb ├── vulnerability_check_api_spec.rb ├── vulnerability_exception_api_spec.rb └── vulnerability_result_api_spec.rb ├── api_client_spec.rb ├── configuration_spec.rb ├── models ├── account_spec.rb ├── additional_information_spec.rb ├── address_spec.rb ├── adhoc_scan_spec.rb ├── advisory_link_spec.rb ├── alert_spec.rb ├── assessment_result_spec.rb ├── asset_create_spec.rb ├── asset_created_or_updated_reference_spec.rb ├── asset_group_spec.rb ├── asset_history_spec.rb ├── asset_policy_assessment_spec.rb ├── asset_policy_item_spec.rb ├── asset_policy_spec.rb ├── asset_spec.rb ├── asset_tag_spec.rb ├── asset_vulnerabilities_spec.rb ├── authentication_settings_spec.rb ├── authentication_source_spec.rb ├── available_report_format_spec.rb ├── backups_size_spec.rb ├── bad_request_error_spec.rb ├── configuration_spec.rb ├── console_command_output_spec.rb ├── content_description_spec.rb ├── cpu_info_spec.rb ├── create_authentication_source_spec.rb ├── created_or_updated_reference_spec.rb ├── created_reference_asset_group_id_link_spec.rb ├── created_reference_credential_id_link_spec.rb ├── created_reference_discovery_query_id_link_spec.rb ├── created_reference_engine_id_link_spec.rb ├── created_reference_policy_override_id_link_spec.rb ├── created_reference_scan_id_link_spec.rb ├── created_reference_scan_template_id_link_spec.rb ├── created_reference_spec.rb ├── created_reference_user_id_link_spec.rb ├── created_reference_vulnerability_exception_id_link_spec.rb ├── created_reference_vulnerability_validation_id_link_spec.rb ├── created_referenceint_link_spec.rb ├── criterion_spec.rb ├── database_connection_settings_spec.rb ├── database_settings_spec.rb ├── database_size_spec.rb ├── database_spec.rb ├── discovery_asset_spec.rb ├── discovery_connection_spec.rb ├── discovery_search_criteria_spec.rb ├── disk_free_spec.rb ├── disk_info_spec.rb ├── disk_total_spec.rb ├── dynamic_site_spec.rb ├── engine_pool_spec.rb ├── environment_properties_spec.rb ├── error_spec.rb ├── exception_scope_spec.rb ├── excluded_asset_groups_spec.rb ├── excluded_scan_targets_spec.rb ├── exploit_source_link_spec.rb ├── exploit_source_spec.rb ├── exploit_spec.rb ├── features_spec.rb ├── file_spec.rb ├── fingerprint_spec.rb ├── global_scan_spec.rb ├── group_account_spec.rb ├── host_name_spec.rb ├── i_meta_data_spec.rb ├── included_asset_groups_spec.rb ├── included_scan_targets_spec.rb ├── info_spec.rb ├── install_size_spec.rb ├── installation_total_size_spec.rb ├── internal_server_error_spec.rb ├── json_node_spec.rb ├── jvm_info_spec.rb ├── license_limits_spec.rb ├── license_policy_scanning_benchmarks_spec.rb ├── license_policy_scanning_spec.rb ├── license_reporting_spec.rb ├── license_scanning_spec.rb ├── license_spec.rb ├── link_spec.rb ├── links_spec.rb ├── locale_preferences_spec.rb ├── malware_kit_spec.rb ├── matched_solution_spec.rb ├── memory_free_spec.rb ├── memory_info_spec.rb ├── memory_total_spec.rb ├── not_found_error_spec.rb ├── operating_system_cpe_spec.rb ├── operating_system_spec.rb ├── page_info_spec.rb ├── page_of_asset_group_spec.rb ├── page_of_asset_policy_item_spec.rb ├── page_of_asset_policy_spec.rb ├── page_of_asset_spec.rb ├── page_of_discovery_connection_spec.rb ├── page_of_exploit_spec.rb ├── page_of_global_scan_spec.rb ├── page_of_malware_kit_spec.rb ├── page_of_operating_system_spec.rb ├── page_of_policy_asset_spec.rb ├── page_of_policy_control_spec.rb ├── page_of_policy_group_spec.rb ├── page_of_policy_item_spec.rb ├── page_of_policy_override_spec.rb ├── page_of_policy_rule_spec.rb ├── page_of_policy_spec.rb ├── page_of_report_spec.rb ├── page_of_scan_spec.rb ├── page_of_site_spec.rb ├── page_of_software_spec.rb ├── page_of_tag_spec.rb ├── page_of_user_spec.rb ├── page_of_vulnerability_category_spec.rb ├── page_of_vulnerability_check_spec.rb ├── page_of_vulnerability_exception_spec.rb ├── page_of_vulnerability_finding_spec.rb ├── page_of_vulnerability_reference_spec.rb ├── page_of_vulnerability_spec.rb ├── pci_spec.rb ├── policy_asset_spec.rb ├── policy_benchmark_spec.rb ├── policy_control_spec.rb ├── policy_group_spec.rb ├── policy_item_spec.rb ├── policy_metadata_resource_spec.rb ├── policy_override_reviewer_spec.rb ├── policy_override_scope_spec.rb ├── policy_override_spec.rb ├── policy_override_submitter_spec.rb ├── policy_rule_assessment_resource_spec.rb ├── policy_rule_spec.rb ├── policy_spec.rb ├── policy_summary_resource_spec.rb ├── privileges_spec.rb ├── range_resource_spec.rb ├── reference_with_alert_id_link_spec.rb ├── reference_with_asset_id_link_spec.rb ├── reference_with_endpoint_id_link_spec.rb ├── reference_with_engine_id_link_spec.rb ├── reference_with_report_id_link_spec.rb ├── reference_with_scan_schedule_id_link_spec.rb ├── reference_with_site_id_link_spec.rb ├── reference_with_tag_id_link_spec.rb ├── reference_with_user_id_link_spec.rb ├── references_with_asset_group_id_link_spec.rb ├── references_with_asset_id_link_spec.rb ├── references_with_engine_id_link_spec.rb ├── references_with_reference_with_endpoint_id_link_service_link_spec.rb ├── references_with_site_id_link_spec.rb ├── references_with_solution_natural_id_link_spec.rb ├── references_with_tag_id_link_spec.rb ├── references_with_user_id_link_spec.rb ├── references_with_vulnerability_check_id_link_spec.rb ├── references_with_vulnerability_check_type_id_link_spec.rb ├── references_with_vulnerability_natural_id_link_spec.rb ├── references_with_web_application_id_link_spec.rb ├── remediation_resource_spec.rb ├── repeat_spec.rb ├── report_config_category_filters_spec.rb ├── report_config_database_credentials_resource_spec.rb ├── report_config_database_resource_spec.rb ├── report_config_filters_resource_spec.rb ├── report_config_scope_resource_spec.rb ├── report_email_smtp_spec.rb ├── report_email_spec.rb ├── report_filters_spec.rb ├── report_frequency_spec.rb ├── report_instance_spec.rb ├── report_repeat_spec.rb ├── report_scope_spec.rb ├── report_size_spec.rb ├── report_spec.rb ├── report_storage_spec.rb ├── report_template_spec.rb ├── resources_alert_spec.rb ├── resources_asset_group_spec.rb ├── resources_asset_tag_spec.rb ├── resources_authentication_source_spec.rb ├── resources_available_report_format_spec.rb ├── resources_configuration_spec.rb ├── resources_database_spec.rb ├── resources_discovery_asset_spec.rb ├── resources_engine_pool_spec.rb ├── resources_file_spec.rb ├── resources_group_account_spec.rb ├── resources_matched_solution_spec.rb ├── resources_policy_override_spec.rb ├── resources_report_instance_spec.rb ├── resources_report_template_spec.rb ├── resources_role_spec.rb ├── resources_scan_engine_spec.rb ├── resources_scan_schedule_spec.rb ├── resources_scan_template_spec.rb ├── resources_shared_credential_spec.rb ├── resources_site_credential_spec.rb ├── resources_site_shared_credential_spec.rb ├── resources_smtp_alert_spec.rb ├── resources_snmp_alert_spec.rb ├── resources_software_spec.rb ├── resources_solution_spec.rb ├── resources_sonar_query_spec.rb ├── resources_syslog_alert_spec.rb ├── resources_tag_spec.rb ├── resources_user_account_spec.rb ├── resources_user_spec.rb ├── resources_vulnerability_validation_resource_spec.rb ├── resources_web_form_authentication_spec.rb ├── resources_web_header_authentication_spec.rb ├── review_spec.rb ├── risk_modifier_settings_spec.rb ├── risk_settings_spec.rb ├── risk_trend_all_assets_resource_spec.rb ├── risk_trend_resource_spec.rb ├── role_spec.rb ├── scan_engine_spec.rb ├── scan_events_spec.rb ├── scan_schedule_spec.rb ├── scan_scope_spec.rb ├── scan_settings_spec.rb ├── scan_size_spec.rb ├── scan_spec.rb ├── scan_targets_resource_spec.rb ├── scan_template_asset_discovery_spec.rb ├── scan_template_database_spec.rb ├── scan_template_discovery_performance_packets_rate_spec.rb ├── scan_template_discovery_performance_parallelism_spec.rb ├── scan_template_discovery_performance_scan_delay_spec.rb ├── scan_template_discovery_performance_spec.rb ├── scan_template_discovery_performance_timeout_spec.rb ├── scan_template_discovery_spec.rb ├── scan_template_service_discovery_spec.rb ├── scan_template_service_discovery_tcp_spec.rb ├── scan_template_service_discovery_udp_spec.rb ├── scan_template_spec.rb ├── scan_template_vulnerability_check_categories_spec.rb ├── scan_template_vulnerability_check_individual_spec.rb ├── scan_template_vulnerability_checks_spec.rb ├── scan_template_web_spider_paths_spec.rb ├── scan_template_web_spider_patterns_spec.rb ├── scan_template_web_spider_performance_spec.rb ├── scan_template_web_spider_spec.rb ├── scheduled_scan_targets_spec.rb ├── search_criteria_spec.rb ├── service_link_spec.rb ├── service_spec.rb ├── service_unavailable_error_spec.rb ├── settings_spec.rb ├── shared_credential_account_spec.rb ├── shared_credential_spec.rb ├── site_create_resource_spec.rb ├── site_credential_spec.rb ├── site_discovery_connection_spec.rb ├── site_organization_spec.rb ├── site_shared_credential_spec.rb ├── site_spec.rb ├── site_update_resource_spec.rb ├── smtp_alert_spec.rb ├── smtp_settings_spec.rb ├── snmp_alert_spec.rb ├── software_cpe_spec.rb ├── software_spec.rb ├── solution_match_spec.rb ├── solution_spec.rb ├── sonar_criteria_spec.rb ├── sonar_criterion_spec.rb ├── sonar_query_spec.rb ├── static_site_spec.rb ├── steps_spec.rb ├── submission_spec.rb ├── summary_spec.rb ├── swagger_discovery_search_criteria_filter_spec.rb ├── swagger_search_criteria_filter_spec.rb ├── syslog_alert_spec.rb ├── tag_asset_source_spec.rb ├── tag_link_spec.rb ├── tag_spec.rb ├── tagged_asset_references_spec.rb ├── telnet_spec.rb ├── token_resource_spec.rb ├── unauthorized_error_spec.rb ├── unique_id_spec.rb ├── update_id_spec.rb ├── update_info_spec.rb ├── update_settings_spec.rb ├── user_account_spec.rb ├── user_create_role_spec.rb ├── user_edit_spec.rb ├── user_role_spec.rb ├── user_spec.rb ├── version_info_spec.rb ├── vulnerabilities_spec.rb ├── vulnerability_category_spec.rb ├── vulnerability_check_spec.rb ├── vulnerability_check_type_spec.rb ├── vulnerability_cvss_spec.rb ├── vulnerability_cvss_v2_spec.rb ├── vulnerability_cvss_v3_spec.rb ├── vulnerability_events_spec.rb ├── vulnerability_exception_spec.rb ├── vulnerability_finding_spec.rb ├── vulnerability_reference_spec.rb ├── vulnerability_spec.rb ├── vulnerability_validation_resource_spec.rb ├── vulnerability_validation_source_spec.rb ├── web_application_spec.rb ├── web_form_authentication_spec.rb ├── web_header_authentication_spec.rb ├── web_page_spec.rb └── web_settings_spec.rb └── spec_helper.rb /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ### Description 4 | 5 | 6 | 7 | ### Motivation and Context 8 | 9 | 10 | 11 | 12 | ### How Has This Been Tested? 13 | 14 | 15 | 16 | ### Types of changes 17 | 18 | - Bug fix (non-breaking change which fixes an issue) 19 | - New feature (non-breaking change which adds functionality) 20 | - Breaking change (fix or feature that would cause existing functionality to change) 21 | 22 | 23 | ### Checklist: 24 | 25 | 26 | - [ ] I have updated the documentation accordingly (if changes are required). 27 | - [ ] I have tested the changes locally. 28 | 29 | 30 | ### Miscellaneous Details: 31 | 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by: https://github.com/swagger-api/swagger-codegen.git 2 | # 3 | 4 | *.gem 5 | *.rbc 6 | /.config 7 | /coverage/ 8 | /InstalledFiles 9 | /pkg/ 10 | /spec/reports/ 11 | /spec/examples.txt 12 | /test/tmp/ 13 | /test/version_tmp/ 14 | /tmp/ 15 | 16 | ## Specific to RubyMotion: 17 | .dat* 18 | .repl_history 19 | build/ 20 | 21 | ## Documentation cache and generated files: 22 | /.yardoc/ 23 | /_yardoc/ 24 | /doc/ 25 | /rdoc/ 26 | 27 | ## Environment normalization: 28 | /.bundle/ 29 | /vendor/bundle 30 | /lib/bundler/man/ 31 | 32 | # for a library or gem, you might want to ignore these files since the code is 33 | # intended to run in multiple environments; otherwise, check them in: 34 | # Gemfile.lock 35 | # .ruby-version 36 | # .ruby-gemset 37 | 38 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 39 | .rvmrc 40 | 41 | # Added manually 42 | setup_workspace/swagger-codegen-cli-2.3.0.jar 43 | .idea 44 | Gemfile.lock 45 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | --require spec_helper 3 | -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | README.md 8 | .gitignore 9 | LICENSE 10 | -------------------------------------------------------------------------------- /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | 2.4.0 2 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | 5 | group :development, :test do 6 | gem 'rake', '~> 12.0.0' 7 | end 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2018 Rapid7, Inc. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | begin 2 | require 'rspec/core/rake_task' 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | task default: :spec 6 | rescue LoadError 7 | # no rspec available 8 | end 9 | -------------------------------------------------------------------------------- /api-files/api_history.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "console_version": "6.5.1", 4 | "date": "2018-01-11", 5 | "checksum": "b944cbdf6ddeb6471096682c09b24a85f96aec81" 6 | }, 7 | { 8 | "console_version": "6.5.2", 9 | "date": "2018-01-18", 10 | "checksum": "39e231b04de2b9656d416265a2911e694c5e1e31" 11 | }, 12 | { 13 | "console_version": "6.5.3", 14 | "date": "2018-01-24", 15 | "checksum": "85036d0a091b94a176eace301124207c7c7bb904" 16 | }, 17 | { 18 | "console_version": "6.5.4", 19 | "date": "2018-02-02", 20 | "checksum": "1fb97dfa9a9e5b6d80653e1224fad69c1e1aae32" 21 | }, 22 | { 23 | "console_version": "6.5.19", 24 | "date": "2018-05-22", 25 | "checksum": "b8df9b32db5559edd61ed5f0770fd2fc00a5d86a" 26 | } 27 | ] 28 | -------------------------------------------------------------------------------- /cortex.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | info: 3 | title: Vm Console Client Ruby 4 | description: The UNOFFICIAL (but useful) Ruby gem for the Rapid7 InsightVM/Nexpose 5 | RESTful API 6 | x-cortex-git: 7 | github: 8 | alias: r7org 9 | repository: rapid7/vm-console-client-ruby 10 | x-cortex-tag: vm-console-client-ruby 11 | x-cortex-type: service 12 | x-cortex-domain-parents: 13 | - tag: vm-console 14 | openapi: 3.0.1 15 | servers: 16 | - url: "/" 17 | -------------------------------------------------------------------------------- /docs/Account.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Account 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **service** | **String** | | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/AdditionalInformation.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AdditionalInformation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **String** | Hypertext Markup Language (HTML) representation of the content. | [optional] 7 | **text** | **String** | Textual representation of the content. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Address.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Address 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ip** | **String** | The IPv4 or IPv6 address. | [optional] 7 | **mac** | **String** | The Media Access Control (MAC) address. The format is six groups of two hexadecimal digits separated by colons. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AdhocScan.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AdhocScan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_group_ids** | **Array<Integer>** | The asset groups that should be included as a part of the scan. Only asset groups assigned to the site can be specified for a scan. This value should be an array of integers representing the unique identifiers of the asset groups. | [optional] 7 | **engine_id** | **Integer** | The identifier of the scan engine. | [optional] 8 | **hosts** | **Array<String>** | The hosts that should be included as a part of the scan. This should be a mixture of IP Addresses and Hostnames as a String array. | [optional] 9 | **name** | **String** | The user-driven scan name for the scan. | [optional] 10 | **template_id** | **String** | The identifier of the scan template | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AdvisoryLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AdvisoryLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **href** | **String** | The hypertext reference for the vulnerability reference. | [optional] 7 | **rel** | **String** | The relation of the hypermedia link, `\"Advisory\"`. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AssetCreatedOrUpdatedReference.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AssetCreatedOrUpdatedReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **body** | [**ReferenceWithAssetIDLink**](ReferenceWithAssetIDLink.md) | | [optional] 7 | **status_code** | **String** | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AssetGroup.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AssetGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **assets** | **Integer** | The number of assets that belong to the asset group. | [optional] 7 | **description** | **String** | The description of the asset group. | [optional] 8 | **id** | **Integer** | The identifier of the asset group. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 10 | **name** | **String** | The name of the asset group. | 11 | **risk_score** | **Float** | The total risk score of all assets that belong to the asset group. | [optional] 12 | **search_criteria** | [**SearchCriteria**](SearchCriteria.md) | Search criteria used to determine dynamic membership, if `type` is `\"dynamic\"`. | [optional] 13 | **type** | **String** | The type of the asset group. | 14 | **vulnerabilities** | [**Vulnerabilities**](Vulnerabilities.md) | Summary information for distinct vulnerabilities found on the assets. | [optional] 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/AssetPolicyAssessment.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AssetPolicyAssessment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **total** | **Integer** | The total number of assets. | [optional] 8 | **total_failed** | **Integer** | The total number of assets that are not compliant. | [optional] 9 | **total_not_applicable** | **Integer** | The total number of assets that are not applicable. | [optional] 10 | **total_passed** | **Integer** | | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AssetTag.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AssetTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **color** | **String** | The color to use when rendering the tag in a user interface. | [optional] 7 | **created** | **String** | The date and time the tag was created. | [optional] 8 | **id** | **Integer** | The identifier of the tag. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 10 | **name** | **String** | The name (label) of the tab. | 11 | **risk_modifier** | **Object** | The amount to adjust risk of an asset tagged with this tag. | [optional] 12 | **search_criteria** | [**SearchCriteria**](SearchCriteria.md) | | [optional] 13 | **source** | **String** | The source of the tag. | [optional] 14 | **sources** | [**Array<TagAssetSource>**](TagAssetSource.md) | The source(s) by which a tag is applied to an asset. | [optional] 15 | **type** | **String** | The type of the tag. | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/AssetVulnerabilities.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AssetVulnerabilities 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **critical** | **Integer** | The number of critical vulnerabilities. | [optional] 7 | **exploits** | **Integer** | The number of distinct exploits that can exploit any of the vulnerabilities on the asset. | [optional] 8 | **malware_kits** | **Integer** | The number of distinct malware kits that vulnerabilities on the asset are susceptible to. | [optional] 9 | **moderate** | **Integer** | The number of moderate vulnerabilities. | [optional] 10 | **severe** | **Integer** | The number of severe vulnerabilities. | [optional] 11 | **total** | **Integer** | The total number of vulnerabilities. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AuthenticationSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AuthenticationSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_2fa** | **BOOLEAN** | Whether two-factor authentication is enabled. | [optional] 7 | **login_lock_threshold** | **Integer** | The maximum number of failed login attempts for an account becomes locked. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/AuthenticationSource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AuthenticationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **external** | **BOOLEAN** | Whether the authentication source is external (true) or internal (false). | [optional] 7 | **id** | **Integer** | The identifier of the authentication source. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **name** | **String** | The name of the authentication source. | [optional] 10 | **type** | **String** | The type of the authentication source. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AvailableReportFormat.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::AvailableReportFormat 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **format** | **String** | The output file-format of a report. | [optional] 7 | **templates** | **Array<String>** | The report template identifiers that can be used within a report format. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/BackupsSize.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::BackupsSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/BadRequestError.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::BadRequestError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **String** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **String** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/CPUInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CPUInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **clock_speed** | **Integer** | The clock speed of the host, in MHz. | [optional] 7 | **count** | **Integer** | The number of CPUs. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Configuration.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Configuration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | The name of the configuration value. | 7 | **value** | **String** | The configuration value. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ConsoleCommandOutput.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ConsoleCommandOutput 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **output** | **String** | The output of the command that was executed. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ContentDescription.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ContentDescription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **String** | Hypertext Markup Language (HTML) representation of the content. | [optional] 7 | **text** | **String** | Textual representation of the content. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreateAuthenticationSource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreateAuthenticationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the authentication source to use to authenticate the user. The source with the specified identifier must be of the type specified by `type`. If `id` is omitted, then one source of the specified `type` is selected. | [optional] 7 | **type** | **String** | The type of the authentication source to use to authenticate the user. | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedOrUpdatedReference.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedOrUpdatedReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Object** | The identifier of the resource created or updated. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReference.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Object** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceAssetGroupIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceAssetGroupIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceCredentialIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceCredentialIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceDiscoveryQueryIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceDiscoveryQueryIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceEngineIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceEngineIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferencePolicyOverrideIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferencePolicyOverrideIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceScanIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceScanIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceScanTemplateIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceScanTemplateIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceUserIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceUserIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceVulnerabilityExceptionIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceVulnerabilityExceptionIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceVulnerabilityValidationIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceVulnerabilityValidationIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/CreatedReferenceintLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::CreatedReferenceintLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource created. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Criterion.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Criterion 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/Database.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Database 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **String** | The description of the database instance. | [optional] 7 | **id** | **Integer** | The identifier of the database. | [optional] 8 | **name** | **String** | The name of the database instance. | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DatabaseConnectionSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DatabaseConnectionSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **maximum_administration_pool_size** | **Integer** | The maximum number of administrative connections in the connection pool. -1 means unlimited. | [optional] 7 | **maximum_pool_size** | **Integer** | ${settings.database.connection.max} | [optional] 8 | **maximum_prepared_statement_pool_size** | **Integer** | The maximum number of prepared statements in the prepared statement pool. -1 means unlimited. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DatabaseSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DatabaseSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **connection** | [**DatabaseConnectionSettings**](DatabaseConnectionSettings.md) | Details connection settings for the database. | [optional] 7 | **host** | **String** | The database host. | [optional] 8 | **maintenance_thread_pool_size** | **Integer** | The maximum number of parallel tasks when executing maintenance tasks. | [optional] 9 | **port** | **Integer** | The database port. | [optional] 10 | **url** | **String** | The database connection URL. | [optional] 11 | **user** | **String** | The database user. | [optional] 12 | **vendor** | **String** | The database vendor. | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DatabaseSize.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DatabaseSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DiscoveryAsset.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DiscoveryAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address** | **String** | The IP address of a discovered asset. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **String** | The host name of a discovered asset. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DiscoverySearchCriteria.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DiscoverySearchCriteria 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **connection_type** | **String** | The type of discovery connection configured for the site. This property only applies to dynamic sites. | [optional] 7 | **filters** | [**Array<SwaggerDiscoverySearchCriteriaFilter>**](SwaggerDiscoverySearchCriteriaFilter.md) | Filters used to match assets from a discovery connection. See <a href=\"#section/Responses/DiscoverySearchCriteria\">Discovery Connection Search Criteria</a> for more information on the structure and format. | [optional] 8 | **match** | **String** | Operator to determine how to match filters. `all` requires that all filters match for an asset to be included. `any` requires only one filter to match for an asset to be included. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DiskFree.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DiskFree 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DiskInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DiskInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **free** | [**DiskFree**](DiskFree.md) | Available disk space. | [optional] 7 | **installation** | [**InstallSize**](InstallSize.md) | Details regarding the size of disk used by the console installation. | [optional] 8 | **total** | [**DiskTotal**](DiskTotal.md) | Total disk space. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DiskTotal.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DiskTotal 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DynamicSite.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::DynamicSite 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the discovery connection. | 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/EnginePool.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::EnginePool 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **engines** | **Array<Integer>** | The identifiers of the scan engines in the engine pool. | [optional] 7 | **id** | **Integer** | The identifier of the scan engine. | 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **name** | **String** | The name of the scan engine. | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/EnvironmentProperties.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::EnvironmentProperties 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **properties** | **Object** | Key-value pairs for system and environment properties that are currently defined. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Error 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **String** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **String** | The HTTP status code for the error (same as in the HTTP response). | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ExceptionScope.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ExceptionScope 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the scope type to which the exception applies. For example in a site scoped vulnerability exception this is the site id, in an asset group vulnerability exception this is the asset group id. | [optional] 7 | **key** | **String** | If the scope type is `\"Instance\"`, an optional key to discriminate the instance the exception applies to. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **port** | **Integer** | If the scope type is `\"Instance\"` and the vulnerability is detected on a service, the port on which the exception applies. | [optional] 10 | **type** | **String** | The type of the exception scope. One of: `\"Global\"`, `\"Site\"`, `\"Asset\"`, `\"Asset Group\"`, `\"Instance\"` | [optional] 11 | **vulnerability** | **String** | The identifier of the vulnerability to which the exception applies. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ExcludedAssetGroups.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ExcludedAssetGroups 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_group_i_ds** | **Array<Integer>** | List of asset group identifiers. Each element is an integer. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ExcludedScanTargets.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ExcludedScanTargets 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **addresses** | **Array<String>** | List of addresses. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Exploit.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Exploit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the exploit. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **skill_level** | **String** | The level of skill required to use the exploit. | [optional] 9 | **source** | [**ExploitSource**](ExploitSource.md) | Details about where the exploit is defined. | [optional] 10 | **title** | **String** | The title (short summary) of the exploit. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ExploitSource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ExploitSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **String** | The identifier of the exploit in the source library. | [optional] 7 | **link** | [**ExploitSourceLink**](ExploitSourceLink.md) | ${exploit.source.link.description} | [optional] 8 | **name** | **String** | The source library of the exploit, typically the name of the vendor that maintains and/or defined the exploit. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ExploitSourceLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ExploitSourceLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **href** | **String** | The hypertext reference for the exploit source. | [optional] 7 | **id** | **String** | Hypermedia link to the destination of the exploit source. | [optional] 8 | **rel** | **String** | The relation of the hypermedia link, `\"Source\"`. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/File.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::File 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **attributes** | [**Array<Configuration>**](Configuration.md) | Attributes detected on the file. | [optional] 7 | **name** | **String** | The name of the file. | 8 | **size** | **Integer** | The size of the regular file (in bytes). If the file is a directory, no value is returned. | [optional] 9 | **type** | **String** | The type of the file. | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Fingerprint.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Fingerprint 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **String** | The description of the matched fingerprint. | [optional] 7 | **family** | **String** | The family of the matched fingerprint. | [optional] 8 | **product** | **String** | The product of the matched fingerprint. | [optional] 9 | **vendor** | **String** | The description of the matched fingerprint. | [optional] 10 | **version** | **String** | The version of the matched fingerprint. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/GroupAccount.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::GroupAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the user group. | [optional] 7 | **name** | **String** | The name of the user group. | 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/HostName.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::HostName 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | The host name (local or FQDN). | 7 | **source** | **String** | The source used to detect the host name. `user` indicates the host name source is user-supplied (e.g. in a site target definition). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/IMetaData.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::IMetaData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field_name** | **String** | | [optional] 7 | **supported_operators** | **Array<String>** | | [optional] 8 | **type** | **String** | | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/IncludedAssetGroups.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::IncludedAssetGroups 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_group_i_ds** | **Array<Integer>** | List of asset group identifiers. Each element is an integer. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/IncludedScanTargets.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::IncludedScanTargets 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **addresses** | **Array<String>** | List of addresses. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/InstallSize.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::InstallSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **backups** | [**BackupsSize**](BackupsSize.md) | The disk space used by backups. | [optional] 7 | **database** | [**DatabaseSize**](DatabaseSize.md) | The disk space used by the database. | [optional] 8 | **directory** | **File** | The installation directory. | [optional] 9 | **reports** | [**ReportSize**](ReportSize.md) | The disk space used by reports. | [optional] 10 | **scans** | [**ScanSize**](ScanSize.md) | The disk space used by scans. | [optional] 11 | **total** | [**InstallationTotalSize**](InstallationTotalSize.md) | Total disk space used by the installation. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InstallationTotalSize.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::InstallationTotalSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/InternalServerError.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::InternalServerError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **String** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **String** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/JVMInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::JVMInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **String** | The name of the Java Virtual Machine. | [optional] 7 | **start_time** | **String** | The date and time the Java Virtual Machine last started. | [optional] 8 | **uptime** | **String** | Total up-time of the Java Virtual Machine, in ISO 8601 format. For example: `\"PT1H4M24.214S\"`. | [optional] 9 | **vendor** | **String** | The vendor of the Java Virtual Machine. | [optional] 10 | **version** | **String** | The version of the Java Virtual Machine. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/JsonNode.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::JsonNode 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **array** | **BOOLEAN** | | [optional] 7 | **big_decimal** | **BOOLEAN** | | [optional] 8 | **big_integer** | **BOOLEAN** | | [optional] 9 | **binary** | **BOOLEAN** | | [optional] 10 | **boolean** | **BOOLEAN** | | [optional] 11 | **container_node** | **BOOLEAN** | | [optional] 12 | **double** | **BOOLEAN** | | [optional] 13 | **float** | **BOOLEAN** | | [optional] 14 | **floating_point_number** | **BOOLEAN** | | [optional] 15 | **int** | **BOOLEAN** | | [optional] 16 | **integral_number** | **BOOLEAN** | | [optional] 17 | **long** | **BOOLEAN** | | [optional] 18 | **missing_node** | **BOOLEAN** | | [optional] 19 | **node_type** | **String** | | [optional] 20 | **null** | **BOOLEAN** | | [optional] 21 | **number** | **BOOLEAN** | | [optional] 22 | **object** | **BOOLEAN** | | [optional] 23 | **pojo** | **BOOLEAN** | | [optional] 24 | **short** | **BOOLEAN** | | [optional] 25 | **textual** | **BOOLEAN** | | [optional] 26 | **value_node** | **BOOLEAN** | | [optional] 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/License.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::License 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **edition** | **String** | The edition of the product. | [optional] 7 | **evaluation** | **BOOLEAN** | Whether the license is a time-restricted evaluation. | [optional] 8 | **expires** | **String** | The date and time the license expires. | [optional] 9 | **features** | [**Features**](Features.md) | The features available in the license. | [optional] 10 | **limits** | [**LicenseLimits**](LicenseLimits.md) | The limits of the license. | [optional] 11 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 12 | **perpetual** | **BOOLEAN** | Whether the license is perpetual. | [optional] 13 | **status** | **String** | The status of the license. | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/LicenseLimits.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::LicenseLimits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **assets** | **Integer** | The maximum number of assets that can be assessed. | [optional] 7 | **assets_with_hosted_engine** | **Integer** | The maximum number of assets that may be scanned with the hosted scan engine. | [optional] 8 | **scan_engines** | **Integer** | The maximum number of scan engines that may be used. | [optional] 9 | **users** | **Integer** | The maximum number of users allowed. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/LicensePolicyScanning.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::LicensePolicyScanning 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **benchmarks** | [**LicensePolicyScanningBenchmarks**](LicensePolicyScanningBenchmarks.md) | The benchmarks available to policy scan. | [optional] 7 | **scanning** | **BOOLEAN** | Whether policy scanning is allowed. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/LicensePolicyScanningBenchmarks.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::LicensePolicyScanningBenchmarks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cis** | **BOOLEAN** | Whether policy scanning for CIS benchmarks is allowed. | [optional] 7 | **custom** | **BOOLEAN** | Whether custom benchmarks can be used during scanning. | [optional] 8 | **disa** | **BOOLEAN** | Whether policy scanning for DISA benchmarks is allowed. | [optional] 9 | **fdcc** | **BOOLEAN** | Whether policy scanning for FDCC benchmarks is allowed. | [optional] 10 | **usgcb** | **BOOLEAN** | Whether policy scanning for USGCB benchmarks is allowed. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/LicenseReporting.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::LicenseReporting 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **advanced** | **BOOLEAN** | Whether advanced reporting is available. | [optional] 7 | **customizable_csv_export** | **BOOLEAN** | Whether customizable CSV Export is available. | [optional] 8 | **pci** | **BOOLEAN** | Whether PCI reporting is available. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/LicenseScanning.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::LicenseScanning 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **discovery** | **BOOLEAN** | Whether discovery scanning may be used. | [optional] 7 | **policy** | [**LicensePolicyScanning**](LicensePolicyScanning.md) | Details as to whether policy scanning and what benchmarks are available. | [optional] 8 | **scada** | **BOOLEAN** | Whether SCADA scanning may be used. | [optional] 9 | **virtual** | **BOOLEAN** | Whether virtual scanning may be used. | [optional] 10 | **web_application** | **BOOLEAN** | Whether web scanning may be used. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Link.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Link 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **href** | **String** | 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>). | [optional] 7 | **rel** | **String** | 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. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Links.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Links 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/LocalePreferences.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::LocalePreferences 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **default** | **String** | The default language to use. The format is a <a target=\"_blank\" href=\"https://tools.ietf.org/html/bcp47\">IETF BCP 47</a> language tag. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | | [optional] 8 | **reports** | **String** | The language to use to generate reports. The format is a <a target=\"_blank\" href=\"https://tools.ietf.org/html/bcp47\">IETF BCP 47</a> language tag. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/MalwareKit.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::MalwareKit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the malware kit. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **String** | The name of the malware kit. | [optional] 9 | **popularity** | **String** | The name of the malware kit. One of: `\"Rare\"`, `\"Uncommon\"`, `\"Occasional\"`, `\"Common\"`, `\"Popular\"`, `\"Favored\"`, `\"Unknown\"` | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MemoryFree.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::MemoryFree 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/MemoryInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::MemoryInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **free** | [**MemoryFree**](MemoryFree.md) | Free memory. | [optional] 7 | **total** | [**MemoryTotal**](MemoryTotal.md) | Total memory usage. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/MemoryTotal.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::MemoryTotal 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/NotFoundError.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::NotFoundError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **String** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **String** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PCI.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PCI 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **adjusted_cvss_score** | **Integer** | The CVSS score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10. | [optional] 7 | **adjusted_severity_score** | **Integer** | The severity score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10. | [optional] 8 | **fail** | **BOOLEAN** | Whether if present on a host this vulnerability would cause a PCI failure. `true` if \"status\" is `\"Fail\"`, `false` otherwise. | [optional] 9 | **special_notes** | **String** | Any special notes or remarks about the vulnerability that pertain to PCI compliance. | [optional] 10 | **status** | **String** | The PCI compliance status of the vulnerability. One of: `\"Pass\"`, `\"Fail\"`. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **number** | **Integer** | The index (zero-based) of the current page returned. | [optional] 7 | **size** | **Integer** | The maximum size of the page returned. | [optional] 8 | **total_pages** | **Integer** | The total number of pages available. | [optional] 9 | **total_resources** | **Integer** | The total number of resources available across all pages. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PageOfAsset.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Asset>**](Asset.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfAssetGroup.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfAssetGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<AssetGroup>**](AssetGroup.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfAssetPolicy.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfAssetPolicy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<AssetPolicy>**](AssetPolicy.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfAssetPolicyItem.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfAssetPolicyItem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<AssetPolicyItem>**](AssetPolicyItem.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfDiscoveryConnection.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfDiscoveryConnection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<DiscoveryConnection>**](DiscoveryConnection.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfExploit.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfExploit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Exploit>**](Exploit.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfGlobalScan.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfGlobalScan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<GlobalScan>**](GlobalScan.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfMalwareKit.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfMalwareKit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<MalwareKit>**](MalwareKit.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfOperatingSystem.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfOperatingSystem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<OperatingSystem>**](OperatingSystem.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicy.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Policy>**](Policy.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicyAsset.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicyAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<PolicyAsset>**](PolicyAsset.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicyControl.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicyControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<PolicyControl>**](PolicyControl.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicyGroup.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicyGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<PolicyGroup>**](PolicyGroup.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicyItem.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicyItem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<PolicyItem>**](PolicyItem.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicyOverride.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicyOverride 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<PolicyOverride>**](PolicyOverride.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfPolicyRule.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfPolicyRule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<PolicyRule>**](PolicyRule.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfReport.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Report>**](Report.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfScan.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfScan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Scan>**](Scan.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfSite.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfSite 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Site>**](Site.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfSoftware.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfSoftware 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Software>**](Software.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfTag.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Tag>**](Tag.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfUser.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfUser 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<User>**](User.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfVulnerability.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfVulnerability 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<Vulnerability>**](Vulnerability.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityCategory.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfVulnerabilityCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<VulnerabilityCategory>**](VulnerabilityCategory.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityCheck.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfVulnerabilityCheck 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<VulnerabilityCheck>**](VulnerabilityCheck.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityException.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfVulnerabilityException 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<VulnerabilityException>**](VulnerabilityException.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityFinding.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfVulnerabilityFinding 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<VulnerabilityFinding>**](VulnerabilityFinding.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityReference.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PageOfVulnerabilityReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional] 8 | **resources** | [**Array<VulnerabilityReference>**](VulnerabilityReference.md) | The page of resources returned. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Policy.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Policy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **enabled** | **Array<Integer>** | The identifiers of the policies enabled to be checked during a scan. No policies are enabled by default. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **recursive_windows_fs_search** | **BOOLEAN** | Whether recursive windows file searches are enabled, if your internal security practices require this capability. Recursive file searches can increase scan times by several hours, depending on the number of files and other factors, so this setting is disabled for Windows systems by default. Defaults to `false`. | [optional] 9 | **store_scap** | **BOOLEAN** | Whether Asset Reporting Format (ARF) results are stored. If you are required to submit reports of your policy scan results to the U.S. government in ARF for SCAP certification, you will need to store SCAP data so that it can be exported in this format. Note that stored SCAP data can accumulate rapidly, which can have a significant impact on file storage. Defaults to `false`. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PolicyAsset.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **hostname** | **String** | The primary host name (local or FQDN) of the asset. | [optional] 7 | **id** | **Integer** | The identifier of the asset. | [optional] 8 | **ip** | **String** | The primary IPv4 or IPv6 address of the asset. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 10 | **os** | [**OperatingSystem**](OperatingSystem.md) | The full description of the operating system of the asset. | [optional] 11 | **status** | **String** | The overall compliance status of the asset. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PolicyBenchmark.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyBenchmark 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **name** | **String** | The name of the policy's benchmark. | [optional] 8 | **title** | **String** | The title of the policy benchmark. | [optional] 9 | **version** | **String** | The version number of the benchmark that includes the policy. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PolicyControl.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cce_item_id** | **String** | The identifier of the CCE item. | [optional] 7 | **cce_platform** | **String** | The platform of the CCE. | [optional] 8 | **control_name** | **String** | The name of the control mapping. | [optional] 9 | **id** | **String** | The textual representation of the control identifier. | [optional] 10 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 11 | **published_date** | **Integer** | The published date of the control mapping. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PolicyMetadataResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyMetadataResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **name** | **String** | The name of the policy. | [optional] 8 | **title** | **String** | The title of the policy as visible to the user. | [optional] 9 | **version** | **String** | The version of the policy. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PolicyOverrideReviewer.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyOverrideReviewer 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **String** | A comment from the reviewer detailing the review. Cannot exceed 1024 characters. | [optional] 7 | **date** | **String** | The date the review took place. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **name** | **String** | The identifier of the user that reviewed the policy override. | [optional] 10 | **user** | **Integer** | The login name of the user that reviewed the policy override. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PolicyOverrideSubmitter.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyOverrideSubmitter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **String** | A comment from the submitter as to why the policy override was submitted. Cannot exceed 1024 characters. | 7 | **date** | **String** | The date the policy override was submitted. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **name** | **String** | The login name of the user that submitted the policy override. | [optional] 10 | **user** | **Integer** | The identifier of the user that submitted the policy override. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PolicyRuleAssessmentResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicyRuleAssessmentResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **total** | **Integer** | The total number of policy rules. | [optional] 8 | **total_failed** | **Integer** | The total number of policy rules that are not compliant against all assets. | [optional] 9 | **total_not_applicable** | **Integer** | The total number of policy rules that are not applicable against all assets. | [optional] 10 | **total_passed** | **Integer** | The total number of policy rules that are compliant against all assets. | [optional] 11 | **unscored** | **Integer** | The total number of policy rules that have a role of `\"unscored\"`. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PolicySummaryResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::PolicySummaryResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **decreased_compliance** | **Integer** | The total number of policies whose overall compliance has decreased between the last two scans of all assets. The list of scanned policies is based on the user's list of accessible assets. | [optional] 7 | **increased_compliance** | **Integer** | The total number of policies whose overall compliance has increased between the last two scans of all assets. The list of scanned policies is based on the user's list of accessible assets. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **number_of_policies** | **Integer** | The total number of policies available in the Security Console. | [optional] 10 | **overall_compliance** | **Float** | The ratio of compliant rules to the total number of rules across all policies. | [optional] 11 | **scanned_policies** | **Integer** | The total number of policies that were evaluated against assets and have applicable results. The assets considered in the calculation are based on the user's list of accessible assets. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Privileges.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Privileges 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | | [optional] 7 | **resources** | **Array<String>** | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/RangeResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::RangeResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **every** | **String** | If `from` is a custom date the interval amount between reporting periods. | [optional] 7 | **from** | **String** | The start date of the trend, which can either be a duration or a specific date and time. | [optional] 8 | **interval** | **Integer** | If `from` is a custom date the interval between reporting periods. | [optional] 9 | **to** | **String** | The end date of the trend (empty if `from` is a duration). | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithAlertIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithAlertIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithAssetIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithAssetIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithEndpointIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithEndpointIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **port** | **Integer** | The port of the service. | [optional] 8 | **protocol** | **String** | The protocol of the service. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ReferenceWithEngineIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithEngineIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithReportIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithReportIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the report instance. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithScanScheduleIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithScanScheduleIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithSiteIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithSiteIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithTagIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithTagIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferenceWithUserIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferenceWithUserIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the resource. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithAssetGroupIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithAssetGroupIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithAssetIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithAssetIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithEngineIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithEngineIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithReferenceWithEndpointIDLinkServiceLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithReferenceWithEndpointIDLinkServiceLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<ServiceLink>**](ServiceLink.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<ReferenceWithEndpointIDLink>**](ReferenceWithEndpointIDLink.md) | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithSiteIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithSiteIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithSolutionNaturalIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithSolutionNaturalIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<String>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithTagIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithTagIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithUserIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithUserIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithVulnerabilityCheckIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithVulnerabilityCheckIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<String>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithVulnerabilityCheckTypeIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithVulnerabilityCheckTypeIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<String>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithVulnerabilityNaturalIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithVulnerabilityNaturalIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<String>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReferencesWithWebApplicationIDLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReferencesWithWebApplicationIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<Integer>** | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/RemediationResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::RemediationResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **solutions** | **Integer** | The number of remediations to display. | [optional] 7 | **sort** | **String** | The attribute to prioritize remediation impact. Only supported for the `prioritized-remediations` and `prioritized-remediations-with-details` templates. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReportConfigCategoryFilters.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportConfigCategoryFilters 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **excluded** | **Array<String>** | The vulnerability categories to exclude. Defaults to no categories. | [optional] 7 | **included** | **Array<String>** | The vulnerability categories to include. Defaults to all categories. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ReportConfigDatabaseCredentialsResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportConfigDatabaseCredentialsResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **password** | **String** | ${report.config.database.credential.password.description} | [optional] 7 | **username** | **String** | ${report.config.database.credential.username.description} | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReportConfigDatabaseResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportConfigDatabaseResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **credentials** | [**ReportConfigDatabaseCredentialsResource**](ReportConfigDatabaseCredentialsResource.md) | ${report.config.database.credentials.description} | [optional] 7 | **host** | **String** | The database server host to export to. | [optional] 8 | **name** | **String** | The name of the database to export to. | [optional] 9 | **port** | **Integer** | The database server port to export to. | [optional] 10 | **vendor** | **String** | The type of the database server. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReportConfigFiltersResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportConfigFiltersResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **categories** | [**ReportConfigCategoryFilters**](ReportConfigCategoryFilters.md) | Vulnerability categories to include or exclude. Only `included` or `excluded` may be specified, but not both. | [optional] 7 | **severity** | **String** | The vulnerability severities to include. Defaults to `all`. | [optional] 8 | **statuses** | **Array<String>** | The vulnerability statuses to include. Defaults to [ `vulnerable`, `vulnerable-version`, `potentially-vulnerable` ]. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ReportConfigScopeResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportConfigScopeResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_groups** | **Array<Integer>** | ${report.config.asset.groups.description} | [optional] 7 | **assets** | **Array<Integer>** | ${report.config.assets.description} | [optional] 8 | **scan** | **Integer** | ${report.config.scans.description} | [optional] 9 | **sites** | **Array<Integer>** | ${report.config.sites.description} | [optional] 10 | **tags** | **Array<Integer>** | ${report.config.tags.description} | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReportEmail.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportEmail 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **access** | **String** | The format to distribute the report in when sending to users who have explicit access to the report. | [optional] 7 | **additional** | **String** | The format to distribute the report to additional recipients. | [optional] 8 | **additional_recipients** | **Array<String>** | The email address of additional recipients to distribute the report to. | [optional] 9 | **asset_access** | **BOOLEAN** | ${report.config.email.additional.asset.access.description} | [optional] 10 | **owner** | **String** | The format to distribute the report to the owner. | [optional] 11 | **smtp** | [**ReportEmailSmtp**](ReportEmailSmtp.md) | SMTP delivery settings. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ReportEmailSmtp.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportEmailSmtp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **global** | **BOOLEAN** | Whether to use global SMTP settings. If enabled, `sender` and `relay` may not be specified. | [optional] 7 | **relay** | **String** | SMTP relay host or IP address. | [optional] 8 | **sender** | **String** | SMTP sender address. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ReportFilters.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportFilters 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/ReportFrequency.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportFrequency 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **next_runtimes** | **Array<String>** | The next scheduled run-times for generation of the report when type is `schedule`. | [optional] 7 | **repeat** | [**ReportRepeat**](ReportRepeat.md) | How often the report generates when type is `schedule`. | [optional] 8 | **start** | **String** | When the report starts generating when type is `schedule`. | [optional] 9 | **type** | **String** | The frequency to generate the report. `schedule` generates the report every scheduled time interval, and requires the `repeat` and `start` properties to be specified. `scan` generates the report after any scan of any element in the scope of the report. `none` does not generate the report automatically. Defaults to `none`. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReportInstance.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportInstance 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **generated** | **String** | The date the report finished generation. | [optional] 7 | **id** | **Integer** | The identifier of the report instance. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **size** | [**ReportSize**](ReportSize.md) | The size of the report, uncompressed. | [optional] 10 | **status** | **String** | The status of the report generation process. | [optional] 11 | **uri** | **String** | The URI of the report accessible through the web console. Refer to the `Download` relation hyperlink for a download URI. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ReportScope.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportScope 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | 8 | -------------------------------------------------------------------------------- /docs/ReportSize.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReportStorage.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportStorage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **location** | **String** | The location to storage an additional copy of the report. This is a sub-path post-fixed to `$(install_dir)/nsc/reports/$(user)/`. Variables such as `$(report_name)`, `$(date)`, and `$(time)` may be used to generate the directory structure. | [optional] 7 | **path** | **String** | The full path to the additional copy storage location. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReportTemplate.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ReportTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **builtin** | **BOOLEAN** | Whether the report template is builtin. | [optional] 7 | **description** | **String** | The description of the report template. | [optional] 8 | **id** | **String** | The identifier of the report template; | [optional] 9 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 10 | **name** | **String** | The name of the report template. | [optional] 11 | **sections** | **Array<String>** | The sections that comprise the `document` report template. | [optional] 12 | **type** | **String** | The type of the report template. `document` is a templatized, typically printable, report that has various sections of content. `export` is data-oriented output, typically CSV. `file` is a printable report template using a report template file. | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ResourcesAlert.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Alert>**](Alert.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesAssetGroup.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesAssetGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<AssetGroup>**](AssetGroup.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesAssetTag.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesAssetTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<AssetTag>**](AssetTag.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesAuthenticationSource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesAuthenticationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<AuthenticationSource>**](AuthenticationSource.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesAvailableReportFormat.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesAvailableReportFormat 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<AvailableReportFormat>**](AvailableReportFormat.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesConfiguration.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesConfiguration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Configuration>**](Configuration.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesDatabase.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesDatabase 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Database>**](Database.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesDiscoveryAsset.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesDiscoveryAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | | [optional] 7 | **resources** | [**Array<DiscoveryAsset>**](DiscoveryAsset.md) | | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesEnginePool.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesEnginePool 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<EnginePool>**](EnginePool.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesFile.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesFile 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **Array<File>** | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesGroupAccount.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesGroupAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<GroupAccount>**](GroupAccount.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesMatchedSolution.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesMatchedSolution 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<MatchedSolution>**](MatchedSolution.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesPolicyOverride.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesPolicyOverride 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<PolicyOverride>**](PolicyOverride.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesReportInstance.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesReportInstance 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<ReportInstance>**](ReportInstance.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesReportTemplate.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesReportTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<ReportTemplate>**](ReportTemplate.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesRole.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesRole 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Role>**](Role.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesScanEngine.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesScanEngine 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<ScanEngine>**](ScanEngine.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesScanSchedule.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesScanSchedule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<ScanSchedule>**](ScanSchedule.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesScanTemplate.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesScanTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<ScanTemplate>**](ScanTemplate.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSharedCredential.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSharedCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SharedCredential>**](SharedCredential.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSiteCredential.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSiteCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SiteCredential>**](SiteCredential.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSiteSharedCredential.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSiteSharedCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SiteSharedCredential>**](SiteSharedCredential.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSmtpAlert.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSmtpAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SmtpAlert>**](SmtpAlert.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSnmpAlert.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSnmpAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SnmpAlert>**](SnmpAlert.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSoftware.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSoftware 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Software>**](Software.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSolution.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSolution 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Solution>**](Solution.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSonarQuery.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSonarQuery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SonarQuery>**](SonarQuery.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesSyslogAlert.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesSyslogAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<SyslogAlert>**](SyslogAlert.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesTag.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<Tag>**](Tag.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesUser.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesUser 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<User>**](User.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesUserAccount.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesUserAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<UserAccount>**](UserAccount.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesVulnerabilityValidationResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesVulnerabilityValidationResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<VulnerabilityValidationResource>**](VulnerabilityValidationResource.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesWebFormAuthentication.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesWebFormAuthentication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<WebFormAuthentication>**](WebFormAuthentication.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ResourcesWebHeaderAuthentication.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ResourcesWebHeaderAuthentication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<WebHeaderAuthentication>**](WebHeaderAuthentication.md) | The resources returned. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Review.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Review 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **String** | A comment from the reviewer detailing the review. | [optional] 7 | **date** | **String** | The date and time the review took place. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **name** | **String** | The identifier of the user that reviewed the vulnerability exception. | [optional] 10 | **user** | **Integer** | The login name of the user that reviewed the vulnerability exception. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RiskModifierSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::RiskModifierSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **high** | **Float** | ${settings.risk.modifier.high} | [optional] 7 | **low** | **Float** | ${settings.risk.modifier.low} | [optional] 8 | **medium** | **Float** | ${settings.risk.modifier.medium} | [optional] 9 | **very_high** | **Float** | ${settings.risk.modifier.veryHigh} | [optional] 10 | **very_low** | **Float** | ${settings.risk.modifier.veryLow} | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RiskSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::RiskSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **adjust_with_criticality** | **BOOLEAN** | Whether risk is adjusted using criticality tags. | [optional] 7 | **criticality_modifiers** | [**RiskModifierSettings**](RiskModifierSettings.md) | If `adjustWithCriticality` is enabled, details the risk modifiers by criticality tag. | [optional] 8 | **model** | **String** | The risk model used to compute risk. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/RiskTrendAllAssetsResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::RiskTrendAllAssetsResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **total** | **BOOLEAN** | Includes a trend for the total risk of all assets. | [optional] 7 | **trend** | **String** | Whether to include a trend for average risk of all assets or the total number of assets. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Role.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Role 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **String** | The description of the role. | 7 | **id** | **String** | The identifier of the role. | 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **name** | **String** | The human readable name of the role. | 10 | **privileges** | **Array<String>** | The privileges granted to the role. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RootApi.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::RootApi 2 | 3 | All URIs are relative to *https://localhost:3780* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**resources**](RootApi.md#resources) | **GET** /api/3 | Resources 8 | 9 | 10 | # **resources** 11 | > Links resources 12 | 13 | Resources 14 | 15 | Returns a listing of the resources (endpoints) that are available to be invoked in this API. 16 | 17 | ### Example 18 | ```ruby 19 | # load the gem 20 | require 'rapid7_vm_console' 21 | 22 | api_instance = Rapid7VmConsole::RootApi.new 23 | 24 | begin 25 | #Resources 26 | result = api_instance.resources 27 | p result 28 | rescue Rapid7VmConsole::ApiError => e 29 | puts "Exception when calling RootApi->resources: #{e}" 30 | end 31 | ``` 32 | 33 | ### Parameters 34 | This endpoint does not need any parameter. 35 | 36 | ### Return type 37 | 38 | [**Links**](Links.md) 39 | 40 | ### Authorization 41 | 42 | No authorization required 43 | 44 | ### HTTP request headers 45 | 46 | - **Content-Type**: application/json 47 | - **Accept**: application/json;charset=UTF-8 48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /docs/ScanEngine.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanEngine 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address** | **String** | The address the scan engine is hosted. | 7 | **content_version** | **String** | The content version of the scan engine. | [optional] 8 | **engine_pools** | **Array<Integer>** | A list of identifiers of engine pools this engine is included in. | [optional] 9 | **id** | **Integer** | The identifier of the scan engine. | 10 | **last_refreshed_date** | **String** | The date the engine was last refreshed. Date format is in ISO 8601. | [optional] 11 | **last_updated_date** | **String** | The date the engine was last updated. Date format is in ISO 8601. | [optional] 12 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 13 | **name** | **String** | The name of the scan engine. | 14 | **port** | **Integer** | The port used by the scan engine to communicate with the Security Console. | 15 | **product_version** | **String** | The product version of the scan engine. | [optional] 16 | **sites** | **Array<Integer>** | A list of identifiers of each site the scan engine is assigned to. | [optional] 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/ScanEvents.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **failed** | **BOOLEAN** | Generates an alert when a scan fails. Default value is `false`. | 7 | **paused** | **BOOLEAN** | Generates an alert when a scan pauses. Default value is `false`. | 8 | **resumed** | **BOOLEAN** | Generates an alert when a scan resumes. Default value is `false`. | [optional] 9 | **started** | **BOOLEAN** | Generates an alert when a scan starts. Default value is `false`. | 10 | **stopped** | **BOOLEAN** | Generates an alert when a scan stops. Default value is `false`. | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanScope.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanScope 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **assets** | [**StaticSite**](StaticSite.md) | Specify assets to be included in site scans as well as assets to be excluded from site scans. If the property is defined, then at least one address or asset group must be specified for scanning. Property is required when creating a static site. | [optional] 7 | **connection** | [**DynamicSite**](DynamicSite.md) | Specify discovery connection settings for a dynamic site. Property is required when creating a dynamic site. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScanSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **connection_timeout** | **String** | The connection timeout when establishing connections to remote scan engines, in ISO 8601 format. For example: `\"PT15S\"`. | [optional] 7 | **incremental** | **BOOLEAN** | Whether incremental scan results is enabled. | [optional] 8 | **maximum_threads** | **Integer** | The maximum number of scan threads to use in any scan. -1 means this is set by the scan template. | [optional] 9 | **read_timeout** | **String** | The read timeout when establishing connections to remote scan engines, in ISO 8601 format. For example: `\"PT15M\"`. | [optional] 10 | **status_idle_timeout** | **String** | The idle timeout when checking the status of running scans, in ISO 8601 format. For example: `\"PT3M\"`. | [optional] 11 | **status_threads** | **Integer** | The number of threads to use when checking the status of running scans. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ScanSize.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **Integer** | The raw value in bytes. | [optional] 7 | **formatted** | **String** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScanTargetsResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTargetsResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **addresses** | **Array<String>** | List of addresses. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScanTemplateDatabase.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDatabase 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **db2** | **String** | Database name for DB2 database instance. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **oracle** | **Array<String>** | Database name (SID) for an Oracle database instance. | [optional] 9 | **postgres** | **String** | Database name for PostgesSQL database instance. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscovery.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDiscovery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset** | [**ScanTemplateAssetDiscovery**](ScanTemplateAssetDiscovery.md) | Asset discovery settings used during a scan. | [optional] 7 | **performance** | [**ScanTemplateDiscoveryPerformance**](ScanTemplateDiscoveryPerformance.md) | Discovery performance settings used during a scan. | [optional] 8 | **service** | [**ScanTemplateServiceDiscovery**](ScanTemplateServiceDiscovery.md) | Service discovery settings used during a scan. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformance.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDiscoveryPerformance 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **packet_rate** | [**ScanTemplateDiscoveryPerformancePacketsRate**](ScanTemplateDiscoveryPerformancePacketsRate.md) | The number of packets to send per second during scanning. | [optional] 7 | **parallelism** | [**ScanTemplateDiscoveryPerformanceParallelism**](ScanTemplateDiscoveryPerformanceParallelism.md) | The number of discovery connection requests to be sent to target host simultaneously. These settings has no effect if values have been set for `scanDelay`. | [optional] 8 | **retry_limit** | **Integer** | The maximum number of attempts to contact target assets. If the limit is exceeded with no response, the given asset is not scanned. Defaults to `3`. | [optional] 9 | **scan_delay** | [**ScanTemplateDiscoveryPerformanceScanDelay**](ScanTemplateDiscoveryPerformanceScanDelay.md) | The duration to wait between sending packets to each target host during a scan. | [optional] 10 | **timeout** | [**ScanTemplateDiscoveryPerformanceTimeout**](ScanTemplateDiscoveryPerformanceTimeout.md) | The duration to wait between retry attempts. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformancePacketsRate.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDiscoveryPerformancePacketsRate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **defeat_rate_limit** | **BOOLEAN** | Whether defeat rate limit (defeat-rst-ratelimit) is enforced on the minimum packet setting, which can improve scan speed. If it is disabled, the minimum packet rate setting may be ignored when a target limits its rate of RST (reset) responses to a port scan. This can increase scan accuracy by preventing the scan from missing ports. Defaults to `true`. | [optional] 7 | **maximum** | **Integer** | The minimum number of packets to send each second during discovery attempts. Defaults to `0`. | [optional] 8 | **minimum** | **Integer** | The minimum number of packets to send each second during discovery attempts. Defaults to `0`. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformanceParallelism.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDiscoveryPerformanceParallelism 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **maximum** | **Integer** | The maximum number of discovery connection requests send in parallel. Defaults to `0`. | [optional] 7 | **minimum** | **Integer** | The minimum number of discovery connection requests send in parallel. Defaults to `0`. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformanceScanDelay.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDiscoveryPerformanceScanDelay 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **maximum** | **String** | The minimum duration to wait between sending packets to each target host. The value is specified as a ISO8601 duration and can range from `PT0S` (0ms) to `P30S` (30s). Defaults to `PT0S`. | [optional] 7 | **minimum** | **String** | The maximum duration to wait between sending packets to each target host. The value is specified as a ISO8601 duration and can range from `PT0S` (0ms) to `P30S` (30s). Defaults to `PT0S`. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformanceTimeout.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateDiscoveryPerformanceTimeout 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **initial** | **String** | The initial timeout to wait between retry attempts. The value is specified as a ISO8601 duration and can range from `PT0.5S` (500ms) to `P30S` (30s). Defaults to `PT0.5S`. | [optional] 7 | **maximum** | **String** | The maximum time to wait between retries. The value is specified as a ISO8601 duration and can range from `PT0.5S` (500ms) to `P30S` (30s). Defaults to `PT3S`. | [optional] 8 | **minimum** | **String** | The minimum time to wait between retries. The value is specified as a ISO8601 duration and can range from `PT0.5S` (500ms) to `P30S` (30s). Defaults to `PT0.5S`. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateServiceDiscovery.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateServiceDiscovery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **service_name_file** | **String** | An optional file that lists each port and the service that commonly resides on it. If scans cannot identify actual services on ports, service names will be derived from this file in scan results. Defaults to empty. | [optional] 7 | **tcp** | [**ScanTemplateServiceDiscoveryTcp**](ScanTemplateServiceDiscoveryTcp.md) | TCP service discovery settings. | [optional] 8 | **udp** | [**ScanTemplateServiceDiscoveryUdp**](ScanTemplateServiceDiscoveryUdp.md) | UDP service discovery settings. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateServiceDiscoveryTcp.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateServiceDiscoveryTcp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **additional_ports** | **Array<Object>** | Additional TCP ports to scan. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `\"7892-7898\"`). Defaults to empty. | [optional] 7 | **excluded_ports** | **Array<Object>** | TCP ports to exclude from scanning. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `\"7892-7898\"`). Defaults to empty. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **method** | **String** | The method of TCP discovery. Defaults to `SYN`. | [optional] 10 | **ports** | **String** | The TCP ports to scan. Defaults to `well-known`. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateServiceDiscoveryUdp.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateServiceDiscoveryUdp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **additional_ports** | **Array<Object>** | Additional UDP ports to scan. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `\"7892-7898\"`). Defaults to empty. | [optional] 7 | **excluded_ports** | **Array<Object>** | UDP ports to exclude from scanning. Individual ports can be specified as numbers or a string, but port ranges must be strings (e.g. `\"7892-7898\"`). Defaults to empty. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **ports** | **String** | The UDP ports to scan. Defaults to `well-known`. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanTemplateVulnerabilityCheckCategories.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateVulnerabilityCheckCategories 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **disabled** | **Array<String>** | The categories of vulnerability checks to disable during a scan. | [optional] 7 | **enabled** | **Array<String>** | The categories of vulnerability checks to enable during a scan. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateVulnerabilityCheckIndividual.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateVulnerabilityCheckIndividual 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **disabled** | **Array<String>** | The individual vulnerability checks to disable during a scan. | [optional] 7 | **enabled** | **Array<String>** | The individual vulnerability checks to enable during a scan. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateWebSpiderPaths.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateWebSpiderPaths 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **boostrap** | **String** | Paths to bootstrap spidering with. | [optional] 7 | **excluded** | **String** | Paths excluded from spidering. | [optional] 8 | **honor_robot_directives** | **BOOLEAN** | ${scan.template.web.spider.paths.robot.directives.description} | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/ScanTemplateWebSpiderPatterns.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScanTemplateWebSpiderPatterns 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sensitive_content** | **String** | A regular expression that is used to find sensitive content on a page. | [optional] 7 | **sensitive_field** | **String** | A regular expression that is used to find fields that may contain sensitive input. Defaults to `\"(p|pass)(word|phrase|wd|code)\"`. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScheduledScanTargets.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ScheduledScanTargets 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **excluded_asset_groups** | [**ExcludedAssetGroups**](ExcludedAssetGroups.md) | Assets associated with these asset groups will be excluded from the site's scan. | [optional] 7 | **excluded_targets** | [**ExcludedScanTargets**](ExcludedScanTargets.md) | Addresses to be excluded from the site's scan. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. | [optional] 8 | **included_asset_groups** | [**IncludedAssetGroups**](IncludedAssetGroups.md) | Allows users to specify a subset of the site's included asset groups to be included in the scan. If the property is defined, then at least one valid already defined as an included asset group must be specified. | [optional] 9 | **included_targets** | [**IncludedScanTargets**](IncludedScanTargets.md) | Allows users to specify a subset of the site's scan targets to be included in the scan. If the property is defined, then at least one address must be specified. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SearchCriteria.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SearchCriteria 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filters** | [**Array<SwaggerSearchCriteriaFilter>**](SwaggerSearchCriteriaFilter.md) | Filters used to match assets. See <a href=\"#section/Responses/SearchCriteria\">Search Criteria</a> for more information on the structure and format. | [optional] 7 | **match** | **String** | Operator to determine how to match filters. `all` requires that all filters match for an asset to be included. `any` requires only one filter to match for an asset to be included. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ServiceLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ServiceLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **href** | **String** | 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>). | [optional] 7 | **port** | **Integer** | The port of the service. | [optional] 8 | **protocol** | **String** | The protocol of the service. | [optional] 9 | **rel** | **String** | 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. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ServiceUnavailableError.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::ServiceUnavailableError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **String** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **String** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SharedCredentialAccount.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SharedCredentialAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **authentication_type** | **String** | | [optional] 7 | **community_name** | **String** | | [optional] 8 | **database** | **String** | | [optional] 9 | **domain** | **String** | | [optional] 10 | **enumerate_sids** | **BOOLEAN** | | [optional] 11 | **notes_id_password** | **String** | | [optional] 12 | **ntlm_hash** | **String** | | [optional] 13 | **oracle_listener_password** | **String** | | [optional] 14 | **password** | **String** | | [optional] 15 | **pem_key** | **String** | | [optional] 16 | **permission_elevation** | **String** | | [optional] 17 | **permission_elevation_password** | **String** | | [optional] 18 | **permission_elevation_username** | **String** | | [optional] 19 | **privacy_password** | **String** | | [optional] 20 | **privacy_type** | **String** | | [optional] 21 | **private_key_password** | **String** | | [optional] 22 | **realm** | **String** | | [optional] 23 | **service** | **String** | | [optional] 24 | **sid** | **String** | | [optional] 25 | **use_windows_authentication** | **BOOLEAN** | | [optional] 26 | **username** | **String** | | [optional] 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/SiteCreateResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SiteCreateResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **String** | The site's description. | [optional] 7 | **engine_id** | **Integer** | The identifier of a scan engine. Default scan engine is selected when not specified. | [optional] 8 | **importance** | **String** | The site importance. Defaults to `\"normal\"` if not specified. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | | [optional] 10 | **name** | **String** | The site name. Name must be unique. | 11 | **scan** | [**ScanScope**](ScanScope.md) | Defines the scope of scan targets for the site, which can be addresses, or asset groups, for static sites and a discovery configuration for dynamic sites. Only one property must be set by the user when saving a site. | [optional] 12 | **scan_template_id** | **String** | The identifier of a scan template. Default scan template is selected when not specified. | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SiteDiscoveryConnection.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SiteDiscoveryConnection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the discovery connection. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **String** | The name of the discovery connection. | [optional] 9 | **type** | **String** | The type of discovery connection configured for the site. This property only applies to dynamic sites. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SiteOrganization.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SiteOrganization 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address** | **String** | The address. | [optional] 7 | **city** | **String** | The city. | [optional] 8 | **contact** | **String** | The contact person name. | [optional] 9 | **country** | **String** | The country. | [optional] 10 | **email** | **String** | The e-mail address. | [optional] 11 | **job_title** | **String** | The job title. | [optional] 12 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 13 | **name** | **String** | The organization name. | [optional] 14 | **phone** | **String** | The phone number. | [optional] 15 | **state** | **String** | The state. | [optional] 16 | **url** | **String** | The organization URL. | [optional] 17 | **zip_code** | **String** | The zip or region code. | [optional] 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/SiteSharedCredential.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SiteSharedCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **enabled** | **BOOLEAN** | Flag indicating whether the shared credential is enabled for the site's scans. | [optional] 7 | **id** | **Integer** | The identifier of the shared credential. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **name** | **String** | The name of the shared credential. | [optional] 10 | **service** | **String** | The type of service the credential is configured to authenticate with. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SiteUpdateResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SiteUpdateResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **String** | The site's description. | [optional] 7 | **engine_id** | **Integer** | The identifier of a scan engine. | 8 | **importance** | **String** | The site importance. | 9 | **links** | [**Array<Link>**](Link.md) | | [optional] 10 | **name** | **String** | The site name. Name must be unique. | 11 | **scan_template_id** | **String** | The identifier of a scan template. | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SmtpSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SmtpSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **host** | **String** | The host to send to. | [optional] 7 | **port** | **Integer** | The port to send to. | [optional] 8 | **sender** | **String** | The sender to send from. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Software.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Software 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **configurations** | [**Array<Configuration>**](Configuration.md) | ${software.attributes.description} | [optional] 7 | **cpe** | [**SoftwareCpe**](SoftwareCpe.md) | The Common Platform Enumeration (CPE) of the software. | [optional] 8 | **description** | **String** | The description of the software. | [optional] 9 | **family** | **String** | The family of the software. | [optional] 10 | **id** | **Integer** | | [optional] 11 | **product** | **String** | The product of the software. | [optional] 12 | **type** | **String** | The version of the software. | [optional] 13 | **vendor** | **String** | The vendor of the software. | [optional] 14 | **version** | **String** | The version of the software. | [optional] 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Solution.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Solution 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **additional_information** | [**AdditionalInformation**](AdditionalInformation.md) | Additional information or resources that can assist in applying the remediation. | [optional] 7 | **applies_to** | **String** | The systems or software the solution applies to. | [optional] 8 | **estimate** | **String** | The estimated duration to apply the solution, in ISO 8601 format. For example: `\"PT5M\"`. | [optional] 9 | **id** | **String** | The identifier of the solution. | [optional] 10 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 11 | **steps** | [**Steps**](Steps.md) | The steps required to remediate the vulnerability. | [optional] 12 | **summary** | [**Summary**](Summary.md) | The summary of the solution. | [optional] 13 | **type** | **String** | The type of the solution. One of: `\"Configuration\"`, `\"Rollup patch\"`, `\"Patch\"` | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SolutionMatch.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SolutionMatch 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **check** | **String** | The identifier of the vulnerability check used to match the solution, if type is `check`. | [optional] 7 | **confidence** | **String** | The confidence of the matching process for the solution. | [optional] 8 | **fingerprint** | [**Fingerprint**](Fingerprint.md) | The fingerprint used to perform solution matching, if type is `operating-system`, `service`, or `software`. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 10 | **solution** | **String** | The identifier of the matched solution. | [optional] 11 | **type** | **String** | The means by which a solution was matched. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SonarCriteria.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SonarCriteria 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filters** | [**Array<SonarCriterion>**](SonarCriterion.md) | The filters in the Sonar query. | [optional] 7 | 8 | 9 | -------------------------------------------------------------------------------- /docs/SonarCriterion.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SonarCriterion 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **days** | **Integer** | If the field is `scan-date-within-the-last`, the number of days to search against. | [optional] 7 | **lower** | **String** | If the field is `ip-address-range`, the lower limit of the search. | [optional] 8 | **search_domain** | **String** | If the field is `domain-contains`, the domain to search against. | [optional] 9 | **type** | **String** | The type of query to perform. | [optional] 10 | **upper** | **String** | If the field is `ip-address-range`, the upper limit of the search. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SonarQuery.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SonarQuery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **criteria** | [**SonarCriteria**](SonarCriteria.md) | The search criteria used to search for assets from the Sonar API. | [optional] 7 | **id** | **Integer** | The identifier of the Sonar query. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **name** | **String** | The name of the Sonar query. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/StaticSite.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::StaticSite 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **excluded_asset_groups** | [**ExcludedAssetGroups**](ExcludedAssetGroups.md) | Assets associated with these asset groups will be excluded from the site's scan. | [optional] 7 | **excluded_targets** | [**ExcludedScanTargets**](ExcludedScanTargets.md) | Addresses to be excluded from the site's scan. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. | [optional] 8 | **included_asset_groups** | [**IncludedAssetGroups**](IncludedAssetGroups.md) | Assets associated with these asset groups will be included in the site's scan. | [optional] 9 | **included_targets** | [**IncludedScanTargets**](IncludedScanTargets.md) | Addresses to be included in the site's scan. At least one address must be specified in a static site. Each address is a string that can represent either a hostname, ipv4 address, ipv4 address range, ipv6 address, or CIDR notation. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Steps.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Steps 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **String** | Textual representation of the content. | [optional] 7 | **text** | **String** | Textual representation of the content. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Submission.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Submission 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **String** | A comment from the submitter as to why the exception was submitted. | [optional] 7 | **date** | **String** | The date and time the vulnerability exception was submitted. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **name** | **String** | The login name of the user that submitted the vulnerability exception. | [optional] 10 | **reason** | **String** | The reason the vulnerability exception was submitted. One of: `\"False Positive\"`, `\"Compensating Control\"`, `\"Acceptable Use\"`, `\"Acceptable Risk\"`, `\"Other\"` | [optional] 11 | **user** | **Integer** | The identifier of the user that submitted the vulnerability exception. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Summary.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Summary 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **String** | Textual representation of the content. | [optional] 7 | **text** | **String** | Textual representation of the content. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SwaggerDiscoverySearchCriteriaFilter.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SwaggerDiscoverySearchCriteriaFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field** | **String** | The filter field for the search criteria. | [optional] 7 | **lower** | **String** | The lower value to match in a range criteria. | [optional] 8 | **operator** | **String** | The operator on how to match the search criteria. | [optional] 9 | **upper** | **String** | The upper value to match in a range criteria. | [optional] 10 | **value** | **String** | The single value to match using the operator. | [optional] 11 | **values** | **Array<String>** | An array of values to match using the operator. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SwaggerSearchCriteriaFilter.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::SwaggerSearchCriteriaFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field** | **String** | The filter field for the search criteria. | [optional] 7 | **lower** | **String** | The lower value to match in a range criteria. | [optional] 8 | **operator** | **String** | The operator on how to match the search criteria. | [optional] 9 | **upper** | **String** | The upper value to match in a range criteria. | [optional] 10 | **value** | **String** | The single value to match using the operator. | [optional] 11 | **values** | **Array<String>** | An array of values to match using the operator. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Tag.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Tag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **color** | **String** | The color to use when rendering the tag in a user interface. | [optional] 7 | **created** | **String** | The date and time the tag was created. | [optional] 8 | **id** | **Integer** | The identifier of the tag. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | | [optional] 10 | **name** | **String** | The name (label) of the tab. | 11 | **risk_modifier** | **Float** | The amount to adjust risk of an asset tagged with this tag. | [optional] 12 | **search_criteria** | [**SearchCriteria**](SearchCriteria.md) | | [optional] 13 | **source** | **String** | The source of the tag. | [optional] 14 | **type** | **String** | The type of the tag. | 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TagAssetSource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::TagAssetSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | If the `source` is `\"asset-group\"` or `\"site\"` the identifier of the asset group or site that causes the tag to apply to the asset. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **source** | **String** | The source by which a tag applies to an asset. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/TagLink.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::TagLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the tagged asset. | [optional] 7 | **sources** | **Array<String>** | The source(s) by which a tag is applied to an asset. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TaggedAssetReferences.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::TaggedAssetReferences 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**Array<TagLink>**](TagLink.md) | The identifiers of the associated resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Telnet.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Telnet 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **character_set** | **String** | The character set to use. | [optional] 7 | **failed_login_regex** | **String** | Regular expression to match a failed login response. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **login_regex** | **String** | Regular expression to match a login response. | [optional] 10 | **password_prompt_regex** | **String** | Regular expression to match a password prompt. | [optional] 11 | **questionable_login_regex** | **String** | Regular expression to match a potential false negative login response. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/TokenResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::TokenResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **String** | The two-factor authentication token seed (key). | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UnauthorizedError.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UnauthorizedError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **String** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **String** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UniqueId.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UniqueId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | The unique identifier. | 7 | **source** | **String** | The source of the unique identifier. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UpdateId.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UpdateId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **product_id** | **String** | Product update identifier. | [optional] 7 | **version_id** | **String** | Version update identifier. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UpdateInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UpdateInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content** | **String** | The most recent content update. | [optional] 7 | **content_partial** | **String** | The most recent, partially-applied (in-memory), content update. | [optional] 8 | **id** | [**UpdateId**](UpdateId.md) | Details of update identifiers. | [optional] 9 | **product** | **String** | The most recent product update. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UpdateSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content_auto_update** | **BOOLEAN** | Whether automatic content updates are enabled. | [optional] 7 | **enabled** | **BOOLEAN** | Whether updates are enabled. | [optional] 8 | **product_auto_update** | **BOOLEAN** | Whether automatic product updates are enabled. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/User.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::User 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **authentication** | [**AuthenticationSource**](AuthenticationSource.md) | The authentication source used to authenticate the user. | [optional] 7 | **email** | **String** | The email address of the user. | [optional] 8 | **enabled** | **BOOLEAN** | Whether the user account is enabled. | [optional] 9 | **id** | **Integer** | The identifier of the user. | [optional] 10 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 11 | **locale** | [**LocalePreferences**](LocalePreferences.md) | The locale and language preferences for the user. | [optional] 12 | **locked** | **BOOLEAN** | Whether the user account is locked (exceeded maximum password retry attempts). | [optional] 13 | **login** | **String** | The login name of the user. | 14 | **name** | **String** | The full name of the user. | 15 | **role** | [**UserRole**](UserRole.md) | The privileges and role the user is assigned. | [optional] 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UserAccount.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UserAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **full_name** | **String** | The full name of the user account. | [optional] 7 | **id** | **Integer** | The identifier of the user account. | [optional] 8 | **name** | **String** | The name of the user account. | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/UserCreateRole.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UserCreateRole 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **all_asset_groups** | **BOOLEAN** | Whether to grant the user access to all asset groups. Defaults to `false`. | [optional] 7 | **all_sites** | **BOOLEAN** | Whether to grant the user access to all sites. Defaults to `false`. | [optional] 8 | **id** | **String** | The identifier of the role the user is assigned to. | 9 | **superuser** | **BOOLEAN** | Whether the user is a superuser. Defaults to `false`. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UserEdit.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UserEdit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **authentication** | [**CreateAuthenticationSource**](CreateAuthenticationSource.md) | The details of the authentication source used to authenticate the user. | [optional] 7 | **email** | **String** | The email address of the user. | [optional] 8 | **enabled** | **BOOLEAN** | Whether the user account is enabled. Defaults to `true`. | [optional] 9 | **id** | **Integer** | The identifier of the user. | [optional] 10 | **locale** | [**LocalePreferences**](LocalePreferences.md) | The locale and language preferences for the user. | [optional] 11 | **locked** | **BOOLEAN** | Whether the user account is locked (exceeded maximum password retry attempts). | [optional] 12 | **login** | **String** | The login name of the user. | 13 | **name** | **String** | The full name of the user. | 14 | **password** | **String** | The password to use for the user. | 15 | **password_reset_on_login** | **BOOLEAN** | Whether to require a reset of the user's password upon first login. Defaults to `false`. | [optional] 16 | **role** | [**UserCreateRole**](UserCreateRole.md) | The privileges and role to assign the user. | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/UserRole.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::UserRole 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **all_asset_groups** | **BOOLEAN** | Whether the user has access to all asset groups. | [optional] 7 | **all_sites** | **BOOLEAN** | Whether the user has access to all sites. | [optional] 8 | **id** | **String** | The identifier of the role the user is assigned to. | [optional] 9 | **name** | **String** | The name of the role the user is assigned to. | [optional] 10 | **privileges** | **Array<String>** | The privileges granted to the user by their role. | [optional] 11 | **superuser** | **BOOLEAN** | Whether the user is a superuser. | [optional] 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/VersionInfo.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VersionInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **build** | **String** | The build number. | [optional] 7 | **changeset** | **String** | The changeset of the source build. | [optional] 8 | **platform** | **String** | The platform of the build. | [optional] 9 | **semantic** | **String** | The semantic version number of the installation. | [optional] 10 | **update** | [**UpdateInfo**](UpdateInfo.md) | Version update details. | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Vulnerabilities.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::Vulnerabilities 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **critical** | **Integer** | The number of critical vulnerabilities. | [optional] 7 | **moderate** | **Integer** | The number of moderate vulnerabilities. | [optional] 8 | **severe** | **Integer** | The number of severe vulnerabilities. | [optional] 9 | **total** | **Integer** | The total number of vulnerabilities. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/VulnerabilityCategory.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the vulnerability category. | [optional] 7 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **String** | The name of the category. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/VulnerabilityCheckType.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityCheckType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **disabled** | **Array<String>** | The types of vulnerability checks to disable during a scan. | [optional] 7 | **enabled** | **Array<String>** | The types of vulnerability checks to enable during a scan. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/VulnerabilityCvss.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityCvss 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **v2** | [**VulnerabilityCvssV2**](VulnerabilityCvssV2.md) | The Common Vulnerability Scoring System (<a href=\"https://www.first.org/cvss/v2/guide\">CVSS v2</a>) information for the vulnerability. | [optional] 8 | **v3** | [**VulnerabilityCvssV3**](VulnerabilityCvssV3.md) | The Common Vulnerability Scoring System (<a target=\"_blank\" href=\"https://www.first.org/cvss/specification-document\">CVSS v3</a>) information for the vulnerability. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/VulnerabilityEvents.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **confirmed_vulnerabilities** | **BOOLEAN** | Generates an alert for vulnerability results of confirmed vulnerabilties. A vulnerability is \"confirmed\" when asset-specific vulnerability tests, such as exploits, produce positive results. Default value is `true`. | 7 | **potential_vulnerabilities** | **BOOLEAN** | Generates an alert for vulnerability results of potential vulnerabilties. A vulnerability is \"potential\" if a check for a potential vulnerabilty is positive. Default value is `true`. | 8 | **unconfirmed_vulnerabilities** | **BOOLEAN** | Generates an alert for vulnerability results of unconfirmed vulnerabilties. A vulnerability is \"unconfirmed\" when a version of a scanned service or software is known to be vulnerable, but there is no positive verification. Default value is `true`. | 9 | **vulnerability_severity** | **String** | Generates an alert for vulnerability results of the selected vulnerability severity. Default value is `\"any_severity\"`. | 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/VulnerabilityException.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityException 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **expires** | **String** | The date and time the vulnerability exception is set to expire. | [optional] 7 | **id** | **Integer** | The identifier of the vulnerability exception. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **review** | [**Review**](Review.md) | Details regarding the review and/or approval of the exception. | [optional] 10 | **scope** | [**ExceptionScope**](ExceptionScope.md) | The scope of the vulnerability exception, indicating the results it applies to. | [optional] 11 | **state** | **String** | The state of the vulnerability exception. One of: `\"Deleted\"`, `\"Expired\"`, `\"Approved\"`, `\"Rejected\"`, `\"Under Review\". | [optional] 12 | **submit** | [**Submission**](Submission.md) | Details regarding the submission of the exception. | [optional] 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/VulnerabilityFinding.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityFinding 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **String** | The identifier of the vulnerability. | 7 | **instances** | **Integer** | The number of vulnerable occurrences of the vulnerability. This does not include `invulnerable` instances. | 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **results** | [**Array<AssessmentResult>**](AssessmentResult.md) | The vulnerability check results for the finding. Multiple instances may be present if one or more checks fired, or a check has multiple independent results. | [optional] 10 | **since** | **String** | The date and time the finding was was first recorded, in the ISO8601 format. If the result changes status this value is the date and time of the status change. | [optional] 11 | **status** | **String** | The status of the finding. | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/VulnerabilityReference.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **advisory** | [**AdvisoryLink**](AdvisoryLink.md) | Hypermedia link to the destination of the vulnerability reference. | [optional] 7 | **id** | **Integer** | The identifier of the vulnerability reference. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **reference** | **String** | The contents of the reference, typically an identifier or hyperlink. Example: `\"CVE-2011-0762\"` | [optional] 10 | **source** | **String** | The originating source of the reference. Examples: `\"url\"`, `\"cve\"`, `\"bid\"`, `\"redhat\"` | [optional] 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/VulnerabilityValidationResource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityValidationResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **date** | **String** | The date and time the vulnerability was validated, in the ISO8601 format. | [optional] 7 | **id** | **Integer** | The identifier of the vulnerability validation. | [optional] 8 | **links** | [**Array<Link>**](Link.md) | | [optional] 9 | **source** | [**VulnerabilityValidationSource**](VulnerabilityValidationSource.md) | The source used to validate the vulnerability. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/VulnerabilityValidationSource.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::VulnerabilityValidationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **String** | The identifier or name of the exploit that was used to validate the vulnerability. | [optional] 7 | **name** | **String** | The name of the source used to validate the vulnerability. | [optional] 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/WebApplication.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::WebApplication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **Integer** | The identifier of the web application. | [optional] 7 | **pages** | [**Array<WebPage>**](WebPage.md) | The pages discovered on the web application. | [optional] 8 | **root** | **String** | The web root of the web application. | [optional] 9 | **virtual_host** | **String** | The virtual host of the web application. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/WebFormAuthentication.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::WebFormAuthentication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **base_url** | **String** | The base URL is the main address from which all paths in the target Web site begin. Includes the protocol. Example: http://acme.com. | [optional] 7 | **enabled** | **BOOLEAN** | Flag indicating whether the HTML form web authentication is enabled for the site's scans. | [optional] 8 | **id** | **Integer** | The identifier of the HTML form web authentication. | [optional] 9 | **links** | [**Array<Link>**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 10 | **login_regular_expression** | **String** | The regular expression matches the message that the Web server returns if the login attempt fails. | [optional] 11 | **login_url** | **String** | The login page URL contains form for logging on. Include the base URL. Example: http://acme.com/login. | [optional] 12 | **name** | **String** | The HTML form web authentication name. | [optional] 13 | **service** | **String** | Value indicating whether this web authentication configuration is for HTML form authentication or HTTP header authentication. | [optional] 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/WebPage.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::WebPage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link_type** | **String** | The type of link used to traverse or detect the page. | [optional] 7 | **path** | **String** | The path to the page (URI). | [optional] 8 | **response** | **Integer** | The HTTP response code observed with retrieving the page. | [optional] 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/WebSettings.md: -------------------------------------------------------------------------------- 1 | # Rapid7VmConsole::WebSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **max_threads** | **Integer** | The maximum number of request handling threads. | [optional] 7 | **min_threads** | **Integer** | The minimum number of request handling threads. | [optional] 8 | **port** | **Integer** | The port the web server is accepting requests. | [optional] 9 | **session_timeout** | **String** | Session timeout duration, in ISO 8601 format. For example: `\"PT10M\"`. | [optional] 10 | 11 | 12 | -------------------------------------------------------------------------------- /lib/rapid7_vm_console/api_error.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.4.0 8 | 9 | =end 10 | 11 | module Rapid7VmConsole 12 | class ApiError < StandardError 13 | attr_reader :code, :response_headers, :response_body 14 | 15 | # Usage examples: 16 | # ApiError.new 17 | # ApiError.new("message") 18 | # ApiError.new(:code => 500, :response_headers => {}, :response_body => "") 19 | # ApiError.new(:code => 404, :message => "Not Found") 20 | def initialize(arg = nil) 21 | if arg.is_a? Hash 22 | if arg.key?(:message) || arg.key?('message') 23 | super(arg[:message] || arg['message']) 24 | else 25 | super arg 26 | end 27 | 28 | arg.each do |k, v| 29 | instance_variable_set "@#{k}", v 30 | end 31 | else 32 | super arg 33 | end 34 | end 35 | end 36 | end 37 | -------------------------------------------------------------------------------- /lib/rapid7_vm_console/version.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.4.0 8 | 9 | =end 10 | 11 | module Rapid7VmConsole 12 | VERSION = '1.0.0-6.5.50' 13 | end 14 | -------------------------------------------------------------------------------- /samples/settings.yml: -------------------------------------------------------------------------------- 1 | --- 2 | :console: 3 | :host: 'localhost:3780' 4 | :user: 'nxadmin' 5 | :pass: 'nxpassword' 6 | :verify_ssl: false 7 | :verify_ssl_host: false 8 | :debug: false 9 | -------------------------------------------------------------------------------- /setup_workspace/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "gemName": "rapid7_vm_console", 3 | "moduleName": "Rapid7VmConsole", 4 | "gemVersion": "1.0.0-6.5.50", 5 | "gemHomepage": "https://github.com/rapid7/vm-console-client-ruby", 6 | "gemSummary": "A ruby wrapper for the Rapid7 Nexpose and InsightVM Console API v3", 7 | "gemLicense": "MIT" 8 | } 9 | -------------------------------------------------------------------------------- /setup_workspace/swagger-codegen-cli-2.4.0.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rapid7/vm-console-client-ruby/bcfa9e4afa53bc32cc43deb4b1722e50283db8f5/setup_workspace/swagger-codegen-cli-2.4.0.jar -------------------------------------------------------------------------------- /spec/api/root_api_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | 14 | # Unit tests for Rapid7VmConsole::RootApi 15 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 16 | # Please update as you see appropriate 17 | describe 'RootApi' do 18 | before do 19 | # run before each test 20 | @instance = Rapid7VmConsole::RootApi.new 21 | end 22 | 23 | after do 24 | # run after each test 25 | end 26 | 27 | describe 'test an instance of RootApi' do 28 | it 'should create an instance of RootApi' do 29 | expect(@instance).to be_instance_of(Rapid7VmConsole::RootApi) 30 | end 31 | end 32 | 33 | # unit tests for resources 34 | # Resources 35 | # Returns a listing of the resources (endpoints) that are available to be invoked in this API. 36 | # @param [Hash] opts the optional parameters 37 | # @return [Links] 38 | describe 'resources test' do 39 | it "should work" do 40 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 41 | end 42 | end 43 | 44 | end 45 | -------------------------------------------------------------------------------- /spec/configuration_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | 13 | describe Rapid7VmConsole::Configuration do 14 | let(:config) { Rapid7VmConsole::Configuration.default } 15 | 16 | before(:each) do 17 | # uncomment below to setup host and base_path 18 | #require 'URI' 19 | #uri = URI.parse("https://localhost:3780") 20 | #Rapid7VmConsole.configure do |c| 21 | # c.host = uri.host 22 | # c.base_path = uri.path 23 | #end 24 | end 25 | 26 | describe '#base_url' do 27 | it 'should have the default value' do 28 | # uncomment below to test default value of the base path 29 | #expect(config.base_url).to eq("https://localhost:3780") 30 | end 31 | 32 | it 'should remove trailing slashes' do 33 | [nil, '', '/', '//'].each do |base_path| 34 | config.base_path = base_path 35 | # uncomment below to test trailing slashes 36 | #expect(config.base_url).to eq("https://localhost:3780") 37 | end 38 | end 39 | end 40 | end 41 | -------------------------------------------------------------------------------- /spec/models/account_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Account 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Account' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Account.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Account' do 29 | it 'should create an instance of Account' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Account) 31 | end 32 | end 33 | describe 'test attribute "service"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | end 40 | 41 | -------------------------------------------------------------------------------- /spec/models/address_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Address 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Address' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Address.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Address' do 29 | it 'should create an instance of Address' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Address) 31 | end 32 | end 33 | describe 'test attribute "ip"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "mac"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/cpu_info_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::CPUInfo 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'CPUInfo' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::CPUInfo.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of CPUInfo' do 29 | it 'should create an instance of CPUInfo' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::CPUInfo) 31 | end 32 | end 33 | describe 'test attribute "clock_speed"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "count"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/criterion_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Criterion 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Criterion' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Criterion.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Criterion' do 29 | it 'should create an instance of Criterion' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Criterion) 31 | end 32 | end 33 | end 34 | 35 | -------------------------------------------------------------------------------- /spec/models/disk_free_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::DiskFree 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'DiskFree' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::DiskFree.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of DiskFree' do 29 | it 'should create an instance of DiskFree' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::DiskFree) 31 | end 32 | end 33 | describe 'test attribute "bytes"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "formatted"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/disk_total_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::DiskTotal 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'DiskTotal' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::DiskTotal.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of DiskTotal' do 29 | it 'should create an instance of DiskTotal' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::DiskTotal) 31 | end 32 | end 33 | describe 'test attribute "bytes"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "formatted"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/dynamic_site_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::DynamicSite 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'DynamicSite' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::DynamicSite.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of DynamicSite' do 29 | it 'should create an instance of DynamicSite' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::DynamicSite) 31 | end 32 | end 33 | describe 'test attribute "id"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | end 40 | 41 | -------------------------------------------------------------------------------- /spec/models/link_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Link 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Link' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Link.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Link' do 29 | it 'should create an instance of Link' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Link) 31 | end 32 | end 33 | describe 'test attribute "href"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "rel"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/links_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Links 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Links' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Links.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Links' do 29 | it 'should create an instance of Links' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Links) 31 | end 32 | end 33 | describe 'test attribute "links"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | end 40 | 41 | -------------------------------------------------------------------------------- /spec/models/report_filters_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::ReportFilters 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'ReportFilters' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::ReportFilters.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of ReportFilters' do 29 | it 'should create an instance of ReportFilters' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::ReportFilters) 31 | end 32 | end 33 | end 34 | 35 | -------------------------------------------------------------------------------- /spec/models/report_scope_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::ReportScope 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'ReportScope' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::ReportScope.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of ReportScope' do 29 | it 'should create an instance of ReportScope' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::ReportScope) 31 | end 32 | end 33 | end 34 | 35 | -------------------------------------------------------------------------------- /spec/models/scan_size_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::ScanSize 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'ScanSize' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::ScanSize.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of ScanSize' do 29 | it 'should create an instance of ScanSize' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::ScanSize) 31 | end 32 | end 33 | describe 'test attribute "bytes"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "formatted"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/sonar_criteria_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::SonarCriteria 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'SonarCriteria' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::SonarCriteria.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of SonarCriteria' do 29 | it 'should create an instance of SonarCriteria' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::SonarCriteria) 31 | end 32 | end 33 | describe 'test attribute "filters"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | end 40 | 41 | -------------------------------------------------------------------------------- /spec/models/steps_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Steps 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Steps' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Steps.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Steps' do 29 | it 'should create an instance of Steps' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Steps) 31 | end 32 | end 33 | describe 'test attribute "html"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "text"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/summary_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::Summary 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'Summary' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::Summary.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of Summary' do 29 | it 'should create an instance of Summary' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::Summary) 31 | end 32 | end 33 | describe 'test attribute "html"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "text"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | -------------------------------------------------------------------------------- /spec/models/unique_id_spec.rb: -------------------------------------------------------------------------------- 1 | =begin 2 | Ruby InsightVM API Client 3 | 4 | OpenAPI spec version: 3 5 | Contact: support@rapid7.com 6 | Generated by: https://github.com/swagger-api/swagger-codegen.git 7 | Swagger Codegen version: 2.3.0 8 | 9 | =end 10 | 11 | require 'spec_helper' 12 | require 'json' 13 | require 'date' 14 | 15 | # Unit tests for Rapid7VmConsole::UniqueId 16 | # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) 17 | # Please update as you see appropriate 18 | describe 'UniqueId' do 19 | before do 20 | # run before each test 21 | @instance = Rapid7VmConsole::UniqueId.new 22 | end 23 | 24 | after do 25 | # run after each test 26 | end 27 | 28 | describe 'test an instance of UniqueId' do 29 | it 'should create an instance of UniqueId' do 30 | expect(@instance).to be_instance_of(Rapid7VmConsole::UniqueId) 31 | end 32 | end 33 | describe 'test attribute "id"' do 34 | it 'should work' do 35 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 36 | end 37 | end 38 | 39 | describe 'test attribute "source"' do 40 | it 'should work' do 41 | # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers 42 | end 43 | end 44 | 45 | end 46 | 47 | --------------------------------------------------------------------------------