├── .github ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── .swagger-codegen-ignore ├── .swagger-codegen └── VERSION ├── .travis.yml ├── LICENSE ├── README.md ├── api-files └── console-swagger.json ├── cortex.yaml ├── docs ├── Account.md ├── AdditionalInformation.md ├── Address.md ├── AdhocScan.md ├── AdministrationApi.md ├── AdvisoryLink.md ├── Agent.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 ├── MetadataContainer.md ├── NotFoundError.md ├── OperatingSystem.md ├── OperatingSystemCpe.md ├── PCI.md ├── PageInfo.md ├── PageOfAgent.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 ├── RepeatResource.md ├── RepeatSchedule.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 ├── rapid7vmconsole ├── __init__.py ├── api │ ├── __init__.py │ ├── administration_api.py │ ├── asset_api.py │ ├── asset_discovery_api.py │ ├── asset_group_api.py │ ├── credential_api.py │ ├── policy_api.py │ ├── policy_override_api.py │ ├── remediation_api.py │ ├── report_api.py │ ├── root_api.py │ ├── scan_api.py │ ├── scan_engine_api.py │ ├── scan_template_api.py │ ├── site_api.py │ ├── tag_api.py │ ├── user_api.py │ ├── vulnerability_api.py │ ├── vulnerability_check_api.py │ ├── vulnerability_exception_api.py │ └── vulnerability_result_api.py ├── api_client.py ├── configuration.py ├── models │ ├── __init__.py │ ├── account.py │ ├── additional_information.py │ ├── address.py │ ├── adhoc_scan.py │ ├── advisory_link.py │ ├── agent.py │ ├── alert.py │ ├── assessment_result.py │ ├── asset.py │ ├── asset_create.py │ ├── asset_created_or_updated_reference.py │ ├── asset_group.py │ ├── asset_history.py │ ├── asset_policy.py │ ├── asset_policy_assessment.py │ ├── asset_policy_item.py │ ├── asset_tag.py │ ├── asset_vulnerabilities.py │ ├── authentication_settings.py │ ├── authentication_source.py │ ├── available_report_format.py │ ├── backups_size.py │ ├── bad_request_error.py │ ├── configuration.py │ ├── console_command_output.py │ ├── content_description.py │ ├── cpu_info.py │ ├── create_authentication_source.py │ ├── created_or_updated_reference.py │ ├── created_reference.py │ ├── created_reference_asset_group_id_link.py │ ├── created_reference_credential_id_link.py │ ├── created_reference_discovery_query_id_link.py │ ├── created_reference_engine_id_link.py │ ├── created_reference_policy_override_id_link.py │ ├── created_reference_scan_id_link.py │ ├── created_reference_scan_template_id_link.py │ ├── created_reference_user_id_link.py │ ├── created_reference_vulnerability_exception_id_link.py │ ├── created_reference_vulnerability_validation_id_link.py │ ├── created_referenceint_link.py │ ├── criterion.py │ ├── database.py │ ├── database_connection_settings.py │ ├── database_settings.py │ ├── database_size.py │ ├── discovery_asset.py │ ├── discovery_connection.py │ ├── discovery_search_criteria.py │ ├── disk_free.py │ ├── disk_info.py │ ├── disk_total.py │ ├── dynamic_site.py │ ├── engine_pool.py │ ├── environment_properties.py │ ├── error.py │ ├── exception_scope.py │ ├── excluded_asset_groups.py │ ├── excluded_scan_targets.py │ ├── exploit.py │ ├── exploit_source.py │ ├── exploit_source_link.py │ ├── features.py │ ├── file.py │ ├── fingerprint.py │ ├── global_scan.py │ ├── group_account.py │ ├── host_name.py │ ├── i_meta_data.py │ ├── included_asset_groups.py │ ├── included_scan_targets.py │ ├── info.py │ ├── install_size.py │ ├── installation_total_size.py │ ├── internal_server_error.py │ ├── json_node.py │ ├── jvm_info.py │ ├── license.py │ ├── license_limits.py │ ├── license_policy_scanning.py │ ├── license_policy_scanning_benchmarks.py │ ├── license_reporting.py │ ├── license_scanning.py │ ├── link.py │ ├── links.py │ ├── locale_preferences.py │ ├── malware_kit.py │ ├── matched_solution.py │ ├── memory_free.py │ ├── memory_info.py │ ├── memory_total.py │ ├── not_found_error.py │ ├── operating_system.py │ ├── operating_system_cpe.py │ ├── page_info.py │ ├── page_of_agent.py │ ├── page_of_asset.py │ ├── page_of_asset_group.py │ ├── page_of_asset_policy.py │ ├── page_of_asset_policy_item.py │ ├── page_of_discovery_connection.py │ ├── page_of_exploit.py │ ├── page_of_global_scan.py │ ├── page_of_malware_kit.py │ ├── page_of_operating_system.py │ ├── page_of_policy.py │ ├── page_of_policy_asset.py │ ├── page_of_policy_control.py │ ├── page_of_policy_group.py │ ├── page_of_policy_item.py │ ├── page_of_policy_override.py │ ├── page_of_policy_rule.py │ ├── page_of_report.py │ ├── page_of_scan.py │ ├── page_of_site.py │ ├── page_of_software.py │ ├── page_of_tag.py │ ├── page_of_user.py │ ├── page_of_vulnerability.py │ ├── page_of_vulnerability_category.py │ ├── page_of_vulnerability_check.py │ ├── page_of_vulnerability_exception.py │ ├── page_of_vulnerability_finding.py │ ├── page_of_vulnerability_reference.py │ ├── pci.py │ ├── policy.py │ ├── policy_asset.py │ ├── policy_benchmark.py │ ├── policy_control.py │ ├── policy_group.py │ ├── policy_item.py │ ├── policy_metadata_resource.py │ ├── policy_override.py │ ├── policy_override_reviewer.py │ ├── policy_override_scope.py │ ├── policy_override_submitter.py │ ├── policy_rule.py │ ├── policy_rule_assessment_resource.py │ ├── policy_summary_resource.py │ ├── privileges.py │ ├── range_resource.py │ ├── reference_with_alert_id_link.py │ ├── reference_with_asset_id_link.py │ ├── reference_with_endpoint_id_link.py │ ├── reference_with_engine_id_link.py │ ├── reference_with_report_id_link.py │ ├── reference_with_scan_schedule_id_link.py │ ├── reference_with_site_id_link.py │ ├── reference_with_tag_id_link.py │ ├── reference_with_user_id_link.py │ ├── references_with_asset_group_id_link.py │ ├── references_with_asset_id_link.py │ ├── references_with_engine_id_link.py │ ├── references_with_reference_with_endpoint_id_link_service_link.py │ ├── references_with_site_id_link.py │ ├── references_with_solution_natural_id_link.py │ ├── references_with_tag_id_link.py │ ├── references_with_user_id_link.py │ ├── references_with_vulnerability_check_id_link.py │ ├── references_with_vulnerability_check_type_id_link.py │ ├── references_with_vulnerability_natural_id_link.py │ ├── references_with_web_application_id_link.py │ ├── remediation_resource.py │ ├── repeat.py │ ├── report.py │ ├── report_config_category_filters.py │ ├── report_config_database_credentials_resource.py │ ├── report_config_database_resource.py │ ├── report_config_filters_resource.py │ ├── report_config_scope_resource.py │ ├── report_email.py │ ├── report_email_smtp.py │ ├── report_filters.py │ ├── report_frequency.py │ ├── report_instance.py │ ├── report_repeat.py │ ├── report_scope.py │ ├── report_size.py │ ├── report_storage.py │ ├── report_template.py │ ├── resources_alert.py │ ├── resources_asset_group.py │ ├── resources_asset_tag.py │ ├── resources_authentication_source.py │ ├── resources_available_report_format.py │ ├── resources_configuration.py │ ├── resources_database.py │ ├── resources_discovery_asset.py │ ├── resources_engine_pool.py │ ├── resources_file.py │ ├── resources_group_account.py │ ├── resources_matched_solution.py │ ├── resources_policy_override.py │ ├── resources_report_instance.py │ ├── resources_report_template.py │ ├── resources_role.py │ ├── resources_scan_engine.py │ ├── resources_scan_schedule.py │ ├── resources_scan_template.py │ ├── resources_shared_credential.py │ ├── resources_site_credential.py │ ├── resources_site_shared_credential.py │ ├── resources_smtp_alert.py │ ├── resources_snmp_alert.py │ ├── resources_software.py │ ├── resources_solution.py │ ├── resources_sonar_query.py │ ├── resources_syslog_alert.py │ ├── resources_tag.py │ ├── resources_user.py │ ├── resources_user_account.py │ ├── resources_vulnerability_validation_resource.py │ ├── resources_web_form_authentication.py │ ├── resources_web_header_authentication.py │ ├── review.py │ ├── risk_modifier_settings.py │ ├── risk_settings.py │ ├── risk_trend_all_assets_resource.py │ ├── risk_trend_resource.py │ ├── role.py │ ├── scan.py │ ├── scan_engine.py │ ├── scan_events.py │ ├── scan_schedule.py │ ├── scan_scope.py │ ├── scan_settings.py │ ├── scan_size.py │ ├── scan_targets_resource.py │ ├── scan_template.py │ ├── scan_template_asset_discovery.py │ ├── scan_template_database.py │ ├── scan_template_discovery.py │ ├── scan_template_discovery_performance.py │ ├── scan_template_discovery_performance_packets_rate.py │ ├── scan_template_discovery_performance_parallelism.py │ ├── scan_template_discovery_performance_scan_delay.py │ ├── scan_template_discovery_performance_timeout.py │ ├── scan_template_service_discovery.py │ ├── scan_template_service_discovery_tcp.py │ ├── scan_template_service_discovery_udp.py │ ├── scan_template_vulnerability_check_categories.py │ ├── scan_template_vulnerability_check_individual.py │ ├── scan_template_vulnerability_checks.py │ ├── scan_template_web_spider.py │ ├── scan_template_web_spider_paths.py │ ├── scan_template_web_spider_patterns.py │ ├── scan_template_web_spider_performance.py │ ├── scheduled_scan_targets.py │ ├── search_criteria.py │ ├── service.py │ ├── service_link.py │ ├── service_unavailable_error.py │ ├── settings.py │ ├── shared_credential.py │ ├── shared_credential_account.py │ ├── site.py │ ├── site_create_resource.py │ ├── site_credential.py │ ├── site_discovery_connection.py │ ├── site_organization.py │ ├── site_shared_credential.py │ ├── site_update_resource.py │ ├── smtp_alert.py │ ├── smtp_settings.py │ ├── snmp_alert.py │ ├── software.py │ ├── software_cpe.py │ ├── solution.py │ ├── solution_match.py │ ├── sonar_criteria.py │ ├── sonar_criterion.py │ ├── sonar_query.py │ ├── static_site.py │ ├── steps.py │ ├── submission.py │ ├── summary.py │ ├── swagger_discovery_search_criteria_filter.py │ ├── swagger_search_criteria_filter.py │ ├── syslog_alert.py │ ├── tag.py │ ├── tag_asset_source.py │ ├── tag_link.py │ ├── tagged_asset_references.py │ ├── telnet.py │ ├── token_resource.py │ ├── unauthorized_error.py │ ├── unique_id.py │ ├── update_id.py │ ├── update_info.py │ ├── update_settings.py │ ├── user.py │ ├── user_account.py │ ├── user_create_role.py │ ├── user_edit.py │ ├── user_role.py │ ├── version_info.py │ ├── vulnerabilities.py │ ├── vulnerability.py │ ├── vulnerability_category.py │ ├── vulnerability_check.py │ ├── vulnerability_check_type.py │ ├── vulnerability_cvss.py │ ├── vulnerability_cvss_v2.py │ ├── vulnerability_cvss_v3.py │ ├── vulnerability_events.py │ ├── vulnerability_exception.py │ ├── vulnerability_finding.py │ ├── vulnerability_reference.py │ ├── vulnerability_validation_resource.py │ ├── vulnerability_validation_source.py │ ├── web_application.py │ ├── web_form_authentication.py │ ├── web_header_authentication.py │ ├── web_page.py │ └── web_settings.py └── rest.py ├── requirements.txt ├── samples ├── generate_sql_report.py └── list_assets.py ├── setup.py ├── setup_workspace ├── config.json └── setup_workspace.sh ├── test-requirements.txt ├── test ├── __init__.py ├── test_account.py ├── test_additional_information.py ├── test_address.py ├── test_adhoc_scan.py ├── test_administration_api.py ├── test_advisory_link.py ├── test_agent.py ├── test_alert.py ├── test_assessment_result.py ├── test_asset.py ├── test_asset_api.py ├── test_asset_create.py ├── test_asset_created_or_updated_reference.py ├── test_asset_discovery_api.py ├── test_asset_group.py ├── test_asset_group_api.py ├── test_asset_history.py ├── test_asset_policy.py ├── test_asset_policy_assessment.py ├── test_asset_policy_item.py ├── test_asset_tag.py ├── test_asset_vulnerabilities.py ├── test_authentication_settings.py ├── test_authentication_source.py ├── test_available_report_format.py ├── test_backups_size.py ├── test_bad_request_error.py ├── test_configuration.py ├── test_console_command_output.py ├── test_content_description.py ├── test_cpu_info.py ├── test_create_authentication_source.py ├── test_created_or_updated_reference.py ├── test_created_reference.py ├── test_created_reference_asset_group_id_link.py ├── test_created_reference_credential_id_link.py ├── test_created_reference_discovery_query_id_link.py ├── test_created_reference_engine_id_link.py ├── test_created_reference_policy_override_id_link.py ├── test_created_reference_scan_id_link.py ├── test_created_reference_scan_template_id_link.py ├── test_created_reference_user_id_link.py ├── test_created_reference_vulnerability_exception_id_link.py ├── test_created_reference_vulnerability_validation_id_link.py ├── test_created_referenceint_link.py ├── test_credential_api.py ├── test_criterion.py ├── test_database.py ├── test_database_connection_settings.py ├── test_database_settings.py ├── test_database_size.py ├── test_discovery_asset.py ├── test_discovery_connection.py ├── test_discovery_search_criteria.py ├── test_disk_free.py ├── test_disk_info.py ├── test_disk_total.py ├── test_dynamic_site.py ├── test_engine_pool.py ├── test_environment_properties.py ├── test_error.py ├── test_exception_scope.py ├── test_excluded_asset_groups.py ├── test_excluded_scan_targets.py ├── test_exploit.py ├── test_exploit_source.py ├── test_exploit_source_link.py ├── test_features.py ├── test_file.py ├── test_fingerprint.py ├── test_global_scan.py ├── test_group_account.py ├── test_host_name.py ├── test_i_meta_data.py ├── test_included_asset_groups.py ├── test_included_scan_targets.py ├── test_info.py ├── test_install_size.py ├── test_installation_total_size.py ├── test_internal_server_error.py ├── test_json_node.py ├── test_jvm_info.py ├── test_license.py ├── test_license_limits.py ├── test_license_policy_scanning.py ├── test_license_policy_scanning_benchmarks.py ├── test_license_reporting.py ├── test_license_scanning.py ├── test_link.py ├── test_links.py ├── test_locale_preferences.py ├── test_malware_kit.py ├── test_matched_solution.py ├── test_memory_free.py ├── test_memory_info.py ├── test_memory_total.py ├── test_metadata_container.py ├── test_not_found_error.py ├── test_operating_system.py ├── test_operating_system_cpe.py ├── test_page_info.py ├── test_page_of_agent.py ├── test_page_of_asset.py ├── test_page_of_asset_group.py ├── test_page_of_asset_policy.py ├── test_page_of_asset_policy_item.py ├── test_page_of_discovery_connection.py ├── test_page_of_exploit.py ├── test_page_of_global_scan.py ├── test_page_of_malware_kit.py ├── test_page_of_operating_system.py ├── test_page_of_policy.py ├── test_page_of_policy_asset.py ├── test_page_of_policy_control.py ├── test_page_of_policy_group.py ├── test_page_of_policy_item.py ├── test_page_of_policy_override.py ├── test_page_of_policy_rule.py ├── test_page_of_report.py ├── test_page_of_scan.py ├── test_page_of_site.py ├── test_page_of_software.py ├── test_page_of_tag.py ├── test_page_of_user.py ├── test_page_of_vulnerability.py ├── test_page_of_vulnerability_category.py ├── test_page_of_vulnerability_check.py ├── test_page_of_vulnerability_exception.py ├── test_page_of_vulnerability_finding.py ├── test_page_of_vulnerability_reference.py ├── test_pci.py ├── test_policy.py ├── test_policy_api.py ├── test_policy_asset.py ├── test_policy_benchmark.py ├── test_policy_control.py ├── test_policy_group.py ├── test_policy_item.py ├── test_policy_metadata_resource.py ├── test_policy_override.py ├── test_policy_override_api.py ├── test_policy_override_reviewer.py ├── test_policy_override_scope.py ├── test_policy_override_submitter.py ├── test_policy_rule.py ├── test_policy_rule_assessment_resource.py ├── test_policy_summary_resource.py ├── test_privileges.py ├── test_range_resource.py ├── test_reference_with_alert_id_link.py ├── test_reference_with_asset_id_link.py ├── test_reference_with_endpoint_id_link.py ├── test_reference_with_engine_id_link.py ├── test_reference_with_report_id_link.py ├── test_reference_with_scan_schedule_id_link.py ├── test_reference_with_site_id_link.py ├── test_reference_with_tag_id_link.py ├── test_reference_with_user_id_link.py ├── test_references_with_asset_group_id_link.py ├── test_references_with_asset_id_link.py ├── test_references_with_engine_id_link.py ├── test_references_with_reference_with_endpoint_id_link_service_link.py ├── test_references_with_site_id_link.py ├── test_references_with_solution_natural_id_link.py ├── test_references_with_tag_id_link.py ├── test_references_with_user_id_link.py ├── test_references_with_vulnerability_check_id_link.py ├── test_references_with_vulnerability_check_type_id_link.py ├── test_references_with_vulnerability_natural_id_link.py ├── test_references_with_web_application_id_link.py ├── test_remediation_api.py ├── test_remediation_resource.py ├── test_repeat.py ├── test_repeat_resource.py ├── test_repeat_schedule.py ├── test_report.py ├── test_report_api.py ├── test_report_config_category_filters.py ├── test_report_config_database_credentials_resource.py ├── test_report_config_database_resource.py ├── test_report_config_filters_resource.py ├── test_report_config_scope_resource.py ├── test_report_email.py ├── test_report_email_smtp.py ├── test_report_filters.py ├── test_report_frequency.py ├── test_report_instance.py ├── test_report_repeat.py ├── test_report_scope.py ├── test_report_size.py ├── test_report_storage.py ├── test_report_template.py ├── test_resources_alert.py ├── test_resources_asset_group.py ├── test_resources_asset_tag.py ├── test_resources_authentication_source.py ├── test_resources_available_report_format.py ├── test_resources_configuration.py ├── test_resources_database.py ├── test_resources_discovery_asset.py ├── test_resources_engine_pool.py ├── test_resources_file.py ├── test_resources_group_account.py ├── test_resources_matched_solution.py ├── test_resources_policy_override.py ├── test_resources_report_instance.py ├── test_resources_report_template.py ├── test_resources_role.py ├── test_resources_scan_engine.py ├── test_resources_scan_schedule.py ├── test_resources_scan_template.py ├── test_resources_shared_credential.py ├── test_resources_site_credential.py ├── test_resources_site_shared_credential.py ├── test_resources_smtp_alert.py ├── test_resources_snmp_alert.py ├── test_resources_software.py ├── test_resources_solution.py ├── test_resources_sonar_query.py ├── test_resources_syslog_alert.py ├── test_resources_tag.py ├── test_resources_user.py ├── test_resources_user_account.py ├── test_resources_vulnerability_validation_resource.py ├── test_resources_web_form_authentication.py ├── test_resources_web_header_authentication.py ├── test_review.py ├── test_risk_modifier_settings.py ├── test_risk_settings.py ├── test_risk_trend_all_assets_resource.py ├── test_risk_trend_resource.py ├── test_role.py ├── test_root_api.py ├── test_scan.py ├── test_scan_api.py ├── test_scan_engine.py ├── test_scan_engine_api.py ├── test_scan_events.py ├── test_scan_schedule.py ├── test_scan_scope.py ├── test_scan_settings.py ├── test_scan_size.py ├── test_scan_targets_resource.py ├── test_scan_template.py ├── test_scan_template_api.py ├── test_scan_template_asset_discovery.py ├── test_scan_template_database.py ├── test_scan_template_discovery.py ├── test_scan_template_discovery_performance.py ├── test_scan_template_discovery_performance_packets_rate.py ├── test_scan_template_discovery_performance_parallelism.py ├── test_scan_template_discovery_performance_scan_delay.py ├── test_scan_template_discovery_performance_timeout.py ├── test_scan_template_service_discovery.py ├── test_scan_template_service_discovery_tcp.py ├── test_scan_template_service_discovery_udp.py ├── test_scan_template_vulnerability_check_categories.py ├── test_scan_template_vulnerability_check_individual.py ├── test_scan_template_vulnerability_checks.py ├── test_scan_template_web_spider.py ├── test_scan_template_web_spider_paths.py ├── test_scan_template_web_spider_patterns.py ├── test_scan_template_web_spider_performance.py ├── test_scheduled_scan_targets.py ├── test_search_criteria.py ├── test_service.py ├── test_service_link.py ├── test_service_unavailable_error.py ├── test_settings.py ├── test_shared_credential.py ├── test_shared_credential_account.py ├── test_site.py ├── test_site_api.py ├── test_site_create_resource.py ├── test_site_credential.py ├── test_site_discovery_connection.py ├── test_site_organization.py ├── test_site_shared_credential.py ├── test_site_update_resource.py ├── test_smtp_alert.py ├── test_smtp_settings.py ├── test_snmp_alert.py ├── test_software.py ├── test_software_cpe.py ├── test_solution.py ├── test_solution_match.py ├── test_sonar_criteria.py ├── test_sonar_criterion.py ├── test_sonar_query.py ├── test_static_site.py ├── test_steps.py ├── test_submission.py ├── test_summary.py ├── test_swagger_discovery_search_criteria_filter.py ├── test_swagger_search_criteria_filter.py ├── test_syslog_alert.py ├── test_tag.py ├── test_tag_api.py ├── test_tag_asset_source.py ├── test_tag_link.py ├── test_tagged_asset_references.py ├── test_telnet.py ├── test_token_resource.py ├── test_unauthorized_error.py ├── test_unique_id.py ├── test_update_id.py ├── test_update_info.py ├── test_update_settings.py ├── test_user.py ├── test_user_account.py ├── test_user_api.py ├── test_user_create_role.py ├── test_user_edit.py ├── test_user_role.py ├── test_version_info.py ├── test_vulnerabilities.py ├── test_vulnerability.py ├── test_vulnerability_api.py ├── test_vulnerability_category.py ├── test_vulnerability_check.py ├── test_vulnerability_check_api.py ├── test_vulnerability_check_type.py ├── test_vulnerability_cvss.py ├── test_vulnerability_cvss_v2.py ├── test_vulnerability_cvss_v3.py ├── test_vulnerability_events.py ├── test_vulnerability_exception.py ├── test_vulnerability_exception_api.py ├── test_vulnerability_finding.py ├── test_vulnerability_reference.py ├── test_vulnerability_result_api.py ├── test_vulnerability_validation_resource.py ├── test_vulnerability_validation_source.py ├── test_web_application.py ├── test_web_form_authentication.py ├── test_web_header_authentication.py ├── test_web_page.py └── test_web_settings.py └── tox.ini /.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.12 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # ref: https://docs.travis-ci.com/user/languages/python 2 | language: python 3 | python: 4 | - "2.7" 5 | - "3.2" 6 | - "3.3" 7 | - "3.4" 8 | - "3.5" 9 | #- "3.5-dev" # 3.5 development branch 10 | #- "nightly" # points to the latest development branch e.g. 3.6-dev 11 | # command to install dependencies 12 | install: "pip install -r requirements.txt" 13 | # command to run tests 14 | script: nosetests 15 | -------------------------------------------------------------------------------- /cortex.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | info: 3 | title: Vm Console Client Python 4 | description: the UNOFFICIAL (but useful) Python library for the Rapid7 InsightVM/Nexpose 5 | RESTful API 6 | x-cortex-git: 7 | github: 8 | alias: r7org 9 | repository: rapid7/vm-console-client-python 10 | x-cortex-tag: vm-console-client-python 11 | x-cortex-type: service 12 | x-cortex-groups: [] 13 | x-cortex-domain-parents: 14 | - tag: vm-console 15 | openapi: 3.0.1 16 | servers: 17 | - url: "/" 18 | -------------------------------------------------------------------------------- /docs/Account.md: -------------------------------------------------------------------------------- 1 | # Account 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **service** | **str** | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/AdditionalInformation.md: -------------------------------------------------------------------------------- 1 | # AdditionalInformation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **str** | Hypertext Markup Language (HTML) representation of the content. | [optional] 7 | **text** | **str** | Textual representation of the content. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Address.md: -------------------------------------------------------------------------------- 1 | # Address 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ip** | **str** | The IPv4 or IPv6 address. | [optional] 7 | **mac** | **str** | The Media Access Control (MAC) address. The format is six groups of two hexadecimal digits separated by colons. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AdvisoryLink.md: -------------------------------------------------------------------------------- 1 | # AdvisoryLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **href** | **str** | The hypertext reference for the vulnerability reference. | [optional] 7 | **rel** | **str** | The relation of the hypermedia link, `\"Advisory\"`. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AssetCreatedOrUpdatedReference.md: -------------------------------------------------------------------------------- 1 | # AssetCreatedOrUpdatedReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **body** | [**ReferenceWithAssetIDLink**](ReferenceWithAssetIDLink.md) | | [optional] 7 | **status_code** | **str** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AssetPolicyAssessment.md: -------------------------------------------------------------------------------- 1 | # AssetPolicyAssessment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **total** | **int** | The total number of assets. | [optional] 8 | **total_failed** | **int** | The total number of assets that are not compliant. | [optional] 9 | **total_not_applicable** | **int** | The total number of assets that are not applicable. | [optional] 10 | **total_passed** | **int** | | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/AssetVulnerabilities.md: -------------------------------------------------------------------------------- 1 | # AssetVulnerabilities 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **critical** | **int** | The number of critical vulnerabilities. | [optional] 7 | **exploits** | **int** | The number of distinct exploits that can exploit any of the vulnerabilities on the asset. | [optional] 8 | **malware_kits** | **int** | The number of distinct malware kits that vulnerabilities on the asset are susceptible to. | [optional] 9 | **moderate** | **int** | The number of moderate vulnerabilities. | [optional] 10 | **severe** | **int** | The number of severe vulnerabilities. | [optional] 11 | **total** | **int** | The total number of vulnerabilities. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/AuthenticationSettings.md: -------------------------------------------------------------------------------- 1 | # AuthenticationSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_2fa** | **bool** | Whether two-factor authentication is enabled. | [optional] 7 | **login_lock_threshold** | **int** | The maximum number of failed login attempts for an account becomes locked. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AuthenticationSource.md: -------------------------------------------------------------------------------- 1 | # AuthenticationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **external** | **bool** | Whether the authentication source is external (true) or internal (false). | [optional] 7 | **id** | **int** | The identifier of the authentication source. | [optional] 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **name** | **str** | The name of the authentication source. | [optional] 10 | **type** | **str** | The type of the authentication source. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/AvailableReportFormat.md: -------------------------------------------------------------------------------- 1 | # AvailableReportFormat 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **format** | **str** | The output file-format of a report. | [optional] 7 | **templates** | **list[str]** | The report template identifiers that can be used within a report format. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/BackupsSize.md: -------------------------------------------------------------------------------- 1 | # BackupsSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/BadRequestError.md: -------------------------------------------------------------------------------- 1 | # BadRequestError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **str** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **str** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CPUInfo.md: -------------------------------------------------------------------------------- 1 | # CPUInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **clock_speed** | **int** | The clock speed of the host, in MHz. | [optional] 7 | **count** | **int** | The number of CPUs. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Configuration.md: -------------------------------------------------------------------------------- 1 | # Configuration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | The name of the configuration value. | 7 | **value** | **str** | The configuration value. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ConsoleCommandOutput.md: -------------------------------------------------------------------------------- 1 | # ConsoleCommandOutput 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **output** | **str** | The output of the command that was executed. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ContentDescription.md: -------------------------------------------------------------------------------- 1 | # ContentDescription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **str** | Hypertext Markup Language (HTML) representation of the content. | [optional] 7 | **text** | **str** | Textual representation of the content. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreateAuthenticationSource.md: -------------------------------------------------------------------------------- 1 | # CreateAuthenticationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | 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** | **str** | The type of the authentication source to use to authenticate the user. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedOrUpdatedReference.md: -------------------------------------------------------------------------------- 1 | # CreatedOrUpdatedReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **object** | The identifier of the resource created or updated. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReference.md: -------------------------------------------------------------------------------- 1 | # CreatedReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **object** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceAssetGroupIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceAssetGroupIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceCredentialIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceCredentialIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceDiscoveryQueryIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceDiscoveryQueryIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceEngineIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceEngineIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferencePolicyOverrideIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferencePolicyOverrideIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceScanIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceScanIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceScanTemplateIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceScanTemplateIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceUserIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceUserIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceVulnerabilityExceptionIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceVulnerabilityExceptionIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceVulnerabilityValidationIDLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceVulnerabilityValidationIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/CreatedReferenceintLink.md: -------------------------------------------------------------------------------- 1 | # CreatedReferenceintLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource created. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Criterion.md: -------------------------------------------------------------------------------- 1 | # Criterion 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Database.md: -------------------------------------------------------------------------------- 1 | # Database 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | The description of the database instance. | [optional] 7 | **id** | **int** | The identifier of the database. | [optional] 8 | **name** | **str** | The name of the database instance. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/DatabaseConnectionSettings.md: -------------------------------------------------------------------------------- 1 | # DatabaseConnectionSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **maximum_administration_pool_size** | **int** | The maximum number of administrative connections in the connection pool. -1 means unlimited. | [optional] 7 | **maximum_pool_size** | **int** | The maximum number of connections in the connection pool. -1 means unlimited. | [optional] 8 | **maximum_prepared_statement_pool_size** | **int** | The maximum number of prepared statements in the prepared statement pool. -1 means unlimited. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/DatabaseSettings.md: -------------------------------------------------------------------------------- 1 | # DatabaseSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **connection** | [**DatabaseConnectionSettings**](DatabaseConnectionSettings.md) | Details connection settings for the database. | [optional] 7 | **host** | **str** | The database host. | [optional] 8 | **maintenance_thread_pool_size** | **int** | The maximum number of parallel tasks when executing maintenance tasks. | [optional] 9 | **port** | **int** | The database port. | [optional] 10 | **url** | **str** | The database connection URL. | [optional] 11 | **user** | **str** | The database user. | [optional] 12 | **vendor** | **str** | The database vendor. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/DatabaseSize.md: -------------------------------------------------------------------------------- 1 | # DatabaseSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DiscoveryAsset.md: -------------------------------------------------------------------------------- 1 | # DiscoveryAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **address** | **str** | The IP address of a discovered asset. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **str** | The host name of a discovered asset. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/DiskFree.md: -------------------------------------------------------------------------------- 1 | # DiskFree 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DiskInfo.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/DiskTotal.md: -------------------------------------------------------------------------------- 1 | # DiskTotal 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DynamicSite.md: -------------------------------------------------------------------------------- 1 | # DynamicSite 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the discovery connection. | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/EnginePool.md: -------------------------------------------------------------------------------- 1 | # EnginePool 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **engines** | **list[int]** | The identifiers of the scan engines in the engine pool. | [optional] 7 | **id** | **int** | The identifier of the scan engine. | 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | **name** | **str** | The name of the scan engine. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/EnvironmentProperties.md: -------------------------------------------------------------------------------- 1 | # EnvironmentProperties 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Error.md: -------------------------------------------------------------------------------- 1 | # Error 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **str** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **str** | The HTTP status code for the error (same as in the HTTP response). | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ExcludedAssetGroups.md: -------------------------------------------------------------------------------- 1 | # ExcludedAssetGroups 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_group_i_ds** | **list[int]** | List of asset group identifiers. Each element is an integer. | [optional] 7 | **links** | [**list[Link]**](Link.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ExcludedScanTargets.md: -------------------------------------------------------------------------------- 1 | # ExcludedScanTargets 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **addresses** | **list[str]** | 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** | [**list[Link]**](Link.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Exploit.md: -------------------------------------------------------------------------------- 1 | # Exploit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the exploit. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **skill_level** | **str** | 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** | **str** | The title (short summary) of the exploit. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ExploitSource.md: -------------------------------------------------------------------------------- 1 | # ExploitSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **str** | The identifier of the exploit in the source library. | [optional] 7 | **link** | [**ExploitSourceLink**](ExploitSourceLink.md) | Link to the source of the exploit. | [optional] 8 | **name** | **str** | The source library of the exploit, typically the name of the vendor that maintains and/or defined the exploit. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ExploitSourceLink.md: -------------------------------------------------------------------------------- 1 | # ExploitSourceLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **href** | **str** | The hypertext reference for the exploit source. | [optional] 7 | **id** | **str** | Hypermedia link to the destination of the exploit source. | [optional] 8 | **rel** | **str** | The relation of the hypermedia link, `\"Source\"`. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/File.md: -------------------------------------------------------------------------------- 1 | # File 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **attributes** | [**list[Configuration]**](Configuration.md) | Attributes detected on the file. | [optional] 7 | **name** | **str** | The name of the file. | 8 | **size** | **int** | The size of the regular file (in bytes). If the file is a directory, no value is returned. | [optional] 9 | **type** | **str** | The type of the file. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Fingerprint.md: -------------------------------------------------------------------------------- 1 | # Fingerprint 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | The description of the matched fingerprint. | [optional] 7 | **family** | **str** | The family of the matched fingerprint. | [optional] 8 | **product** | **str** | The product of the matched fingerprint. | [optional] 9 | **vendor** | **str** | The description of the matched fingerprint. | [optional] 10 | **version** | **str** | The version of the matched fingerprint. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/GroupAccount.md: -------------------------------------------------------------------------------- 1 | # GroupAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the user group. | [optional] 7 | **name** | **str** | The name of the user group. | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/HostName.md: -------------------------------------------------------------------------------- 1 | # HostName 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | The host name (local or FQDN). | 7 | **source** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/IMetaData.md: -------------------------------------------------------------------------------- 1 | # IMetaData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field_name** | **str** | | [optional] 7 | **supported_operators** | **list[str]** | | [optional] 8 | **type** | **str** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/IncludedAssetGroups.md: -------------------------------------------------------------------------------- 1 | # IncludedAssetGroups 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_group_i_ds** | **list[int]** | List of asset group identifiers. Each element is an integer. | [optional] 7 | **links** | [**list[Link]**](Link.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/IncludedScanTargets.md: -------------------------------------------------------------------------------- 1 | # IncludedScanTargets 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **addresses** | **list[str]** | 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** | [**list[Link]**](Link.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InstallSize.md: -------------------------------------------------------------------------------- 1 | # 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** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/InstallationTotalSize.md: -------------------------------------------------------------------------------- 1 | # InstallationTotalSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InternalServerError.md: -------------------------------------------------------------------------------- 1 | # InternalServerError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **str** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **str** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/JVMInfo.md: -------------------------------------------------------------------------------- 1 | # JVMInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **str** | The name of the Java Virtual Machine. | [optional] 7 | **start_time** | **str** | The date and time the Java Virtual Machine last started. | [optional] 8 | **uptime** | **str** | Total up-time of the Java Virtual Machine, in ISO 8601 format. For example: `\"PT1H4M24.214S\"`. | [optional] 9 | **vendor** | **str** | The vendor of the Java Virtual Machine. | [optional] 10 | **version** | **str** | The version of the Java Virtual Machine. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/LicenseLimits.md: -------------------------------------------------------------------------------- 1 | # LicenseLimits 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **assets** | **int** | The maximum number of assets that can be assessed. | [optional] 7 | **assets_with_hosted_engine** | **int** | The maximum number of assets that may be scanned with the hosted scan engine. | [optional] 8 | **scan_engines** | **int** | The maximum number of scan engines that may be used. | [optional] 9 | **users** | **int** | The maximum number of users allowed. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/LicensePolicyScanning.md: -------------------------------------------------------------------------------- 1 | # LicensePolicyScanning 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **benchmarks** | [**LicensePolicyScanningBenchmarks**](LicensePolicyScanningBenchmarks.md) | The benchmarks available to policy scan. | [optional] 7 | **scanning** | **bool** | Whether policy scanning is allowed. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/LicensePolicyScanningBenchmarks.md: -------------------------------------------------------------------------------- 1 | # LicensePolicyScanningBenchmarks 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cis** | **bool** | Whether policy scanning for CIS benchmarks is allowed. | [optional] 7 | **custom** | **bool** | Whether custom benchmarks can be used during scanning. | [optional] 8 | **disa** | **bool** | Whether policy scanning for DISA benchmarks is allowed. | [optional] 9 | **fdcc** | **bool** | Whether policy scanning for FDCC benchmarks is allowed. | [optional] 10 | **usgcb** | **bool** | Whether policy scanning for USGCB benchmarks is allowed. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/LicenseReporting.md: -------------------------------------------------------------------------------- 1 | # LicenseReporting 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **advanced** | **bool** | Whether advanced reporting is available. | [optional] 7 | **customizable_csv_export** | **bool** | Whether customizable CSV Export is available. | [optional] 8 | **pci** | **bool** | Whether PCI reporting is available. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/LicenseScanning.md: -------------------------------------------------------------------------------- 1 | # LicenseScanning 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **discovery** | **bool** | 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** | **bool** | Whether SCADA scanning may be used. | [optional] 9 | **virtual** | **bool** | Whether virtual scanning may be used. | [optional] 10 | **web_application** | **bool** | Whether web scanning may be used. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Links.md: -------------------------------------------------------------------------------- 1 | # Links 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/LocalePreferences.md: -------------------------------------------------------------------------------- 1 | # LocalePreferences 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **default** | **str** | The default language to use. The format is a <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://tools.ietf.org/html/bcp47\">IETF BCP 47</a> language tag. | [optional] 7 | **links** | [**list[Link]**](Link.md) | | [optional] 8 | **reports** | **str** | The language to use to generate reports. The format is a <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://tools.ietf.org/html/bcp47\">IETF BCP 47</a> language tag. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MalwareKit.md: -------------------------------------------------------------------------------- 1 | # MalwareKit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the malware kit. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **str** | The name of the malware kit. | [optional] 9 | **popularity** | **str** | The name of the malware kit. One of: `\"Rare\"`, `\"Uncommon\"`, `\"Occasional\"`, `\"Common\"`, `\"Popular\"`, `\"Favored\"`, `\"Unknown\"` | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MemoryFree.md: -------------------------------------------------------------------------------- 1 | # MemoryFree 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MemoryInfo.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MemoryTotal.md: -------------------------------------------------------------------------------- 1 | # MemoryTotal 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/MetadataContainer.md: -------------------------------------------------------------------------------- 1 | # MetadataContainer 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field_name** | [**IMetaData**](IMetaData.md) | | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/NotFoundError.md: -------------------------------------------------------------------------------- 1 | # NotFoundError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **str** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **str** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageInfo.md: -------------------------------------------------------------------------------- 1 | # PageInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **number** | **int** | The index (zero-based) of the current page returned. | [optional] 7 | **size** | **int** | The maximum size of the page returned. | [optional] 8 | **total_pages** | **int** | The total number of pages available. | [optional] 9 | **total_resources** | **int** | The total number of resources available across all pages. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PageOfAgent.md: -------------------------------------------------------------------------------- 1 | # PageOfAgent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Agent]**](Agent.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfAsset.md: -------------------------------------------------------------------------------- 1 | # PageOfAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Asset]**](Asset.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfAssetGroup.md: -------------------------------------------------------------------------------- 1 | # PageOfAssetGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[AssetGroup]**](AssetGroup.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfAssetPolicy.md: -------------------------------------------------------------------------------- 1 | # PageOfAssetPolicy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[AssetPolicy]**](AssetPolicy.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfAssetPolicyItem.md: -------------------------------------------------------------------------------- 1 | # PageOfAssetPolicyItem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[AssetPolicyItem]**](AssetPolicyItem.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfDiscoveryConnection.md: -------------------------------------------------------------------------------- 1 | # PageOfDiscoveryConnection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[DiscoveryConnection]**](DiscoveryConnection.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfExploit.md: -------------------------------------------------------------------------------- 1 | # PageOfExploit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Exploit]**](Exploit.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfGlobalScan.md: -------------------------------------------------------------------------------- 1 | # PageOfGlobalScan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[GlobalScan]**](GlobalScan.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfMalwareKit.md: -------------------------------------------------------------------------------- 1 | # PageOfMalwareKit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[MalwareKit]**](MalwareKit.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfOperatingSystem.md: -------------------------------------------------------------------------------- 1 | # PageOfOperatingSystem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[OperatingSystem]**](OperatingSystem.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicy.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Policy]**](Policy.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicyAsset.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicyAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[PolicyAsset]**](PolicyAsset.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicyControl.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicyControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[PolicyControl]**](PolicyControl.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicyGroup.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicyGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[PolicyGroup]**](PolicyGroup.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicyItem.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicyItem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[PolicyItem]**](PolicyItem.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicyOverride.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicyOverride 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[PolicyOverride]**](PolicyOverride.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfPolicyRule.md: -------------------------------------------------------------------------------- 1 | # PageOfPolicyRule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[PolicyRule]**](PolicyRule.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfReport.md: -------------------------------------------------------------------------------- 1 | # PageOfReport 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Report]**](Report.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfScan.md: -------------------------------------------------------------------------------- 1 | # PageOfScan 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Scan]**](Scan.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfSite.md: -------------------------------------------------------------------------------- 1 | # PageOfSite 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Site]**](Site.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfSoftware.md: -------------------------------------------------------------------------------- 1 | # PageOfSoftware 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Software]**](Software.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfTag.md: -------------------------------------------------------------------------------- 1 | # PageOfTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Tag]**](Tag.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfUser.md: -------------------------------------------------------------------------------- 1 | # PageOfUser 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[User]**](User.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfVulnerability.md: -------------------------------------------------------------------------------- 1 | # PageOfVulnerability 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[Vulnerability]**](Vulnerability.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityCategory.md: -------------------------------------------------------------------------------- 1 | # PageOfVulnerabilityCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[VulnerabilityCategory]**](VulnerabilityCategory.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityCheck.md: -------------------------------------------------------------------------------- 1 | # PageOfVulnerabilityCheck 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[VulnerabilityCheck]**](VulnerabilityCheck.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityException.md: -------------------------------------------------------------------------------- 1 | # PageOfVulnerabilityException 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[VulnerabilityException]**](VulnerabilityException.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityFinding.md: -------------------------------------------------------------------------------- 1 | # PageOfVulnerabilityFinding 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[VulnerabilityFinding]**](VulnerabilityFinding.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PageOfVulnerabilityReference.md: -------------------------------------------------------------------------------- 1 | # PageOfVulnerabilityReference 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[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** | [**list[VulnerabilityReference]**](VulnerabilityReference.md) | The page of resources returned. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PolicyAsset.md: -------------------------------------------------------------------------------- 1 | # PolicyAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **hostname** | **str** | The primary host name (local or FQDN) of the asset. | [optional] 7 | **id** | **int** | The identifier of the asset. | [optional] 8 | **ip** | **str** | The primary IPv4 or IPv6 address of the asset. | [optional] 9 | **links** | [**list[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** | **str** | The overall compliance status of the asset. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/PolicyBenchmark.md: -------------------------------------------------------------------------------- 1 | # PolicyBenchmark 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **name** | **str** | The name of the policy's benchmark. | [optional] 8 | **title** | **str** | The title of the policy benchmark. | [optional] 9 | **version** | **str** | The version number of the benchmark that includes the policy. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PolicyControl.md: -------------------------------------------------------------------------------- 1 | # PolicyControl 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cce_item_id** | **str** | The identifier of the CCE item. | [optional] 7 | **cce_platform** | **str** | The platform of the CCE. | [optional] 8 | **control_name** | **str** | The name of the control mapping. | [optional] 9 | **id** | **str** | The textual representation of the control identifier. | [optional] 10 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 11 | **published_date** | **int** | The published date of the control mapping. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/PolicyMetadataResource.md: -------------------------------------------------------------------------------- 1 | # PolicyMetadataResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **name** | **str** | The name of the policy. | [optional] 8 | **title** | **str** | The title of the policy as visible to the user. | [optional] 9 | **version** | **str** | The version of the policy. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PolicyOverrideReviewer.md: -------------------------------------------------------------------------------- 1 | # PolicyOverrideReviewer 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **str** | A comment from the reviewer detailing the review. Cannot exceed 1024 characters. | [optional] 7 | **_date** | **str** | The date the review took place. | [optional] 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | **name** | **str** | The identifier of the user that reviewed the policy override. | [optional] 10 | **user** | **int** | The login name of the user that reviewed the policy override. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/PolicyOverrideSubmitter.md: -------------------------------------------------------------------------------- 1 | # PolicyOverrideSubmitter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **str** | A comment from the submitter as to why the policy override was submitted. Cannot exceed 1024 characters. | 7 | **_date** | **str** | The date the policy override was submitted. | [optional] 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | **name** | **str** | The login name of the user that submitted the policy override. | [optional] 10 | **user** | **int** | The identifier of the user that submitted the policy override. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Privileges.md: -------------------------------------------------------------------------------- 1 | # Privileges 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | | [optional] 7 | **resources** | **list[str]** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RangeResource.md: -------------------------------------------------------------------------------- 1 | # RangeResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **every** | **str** | If `from` is a custom date the interval amount between reporting periods. | [optional] 7 | **_from** | **str** | The start date of the trend, which can either be a duration or a specific date and time. | [optional] 8 | **interval** | **int** | If `from` is a custom date the interval between reporting periods. | [optional] 9 | **to** | **str** | The end date of the trend (empty if `from` is a duration). | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ReferenceWithAlertIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithAlertIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithAssetIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithAssetIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithEndpointIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithEndpointIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **port** | **int** | The port of the service. | [optional] 8 | **protocol** | **str** | The protocol of the service. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReferenceWithEngineIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithEngineIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithReportIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithReportIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the report instance. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithScanScheduleIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithScanScheduleIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithSiteIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithSiteIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithTagIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithTagIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferenceWithUserIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferenceWithUserIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the resource. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithAssetGroupIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithAssetGroupIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithAssetIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithAssetIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithEngineIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithEngineIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithReferenceWithEndpointIDLinkServiceLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithReferenceWithEndpointIDLinkServiceLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[ServiceLink]**](ServiceLink.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[ReferenceWithEndpointIDLink]**](ReferenceWithEndpointIDLink.md) | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithSiteIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithSiteIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithSolutionNaturalIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithSolutionNaturalIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[str]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithTagIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithTagIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithUserIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithUserIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithVulnerabilityCheckIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithVulnerabilityCheckIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[str]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithVulnerabilityCheckTypeIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithVulnerabilityCheckTypeIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[str]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithVulnerabilityNaturalIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithVulnerabilityNaturalIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[str]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReferencesWithWebApplicationIDLink.md: -------------------------------------------------------------------------------- 1 | # ReferencesWithWebApplicationIDLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | **list[int]** | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RemediationResource.md: -------------------------------------------------------------------------------- 1 | # RemediationResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **solutions** | **int** | The number of remediations to display. | [optional] 7 | **sort** | **str** | The attribute to prioritize remediation impact. Only supported for the `prioritized-remediations` and `prioritized-remediations-with-details` templates. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReportConfigCategoryFilters.md: -------------------------------------------------------------------------------- 1 | # ReportConfigCategoryFilters 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **excluded** | **list[str]** | The vulnerability categories to exclude. Defaults to no categories. | [optional] 7 | **included** | **list[str]** | The vulnerability categories to include. Defaults to all categories. | [optional] 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReportConfigDatabaseCredentialsResource.md: -------------------------------------------------------------------------------- 1 | # ReportConfigDatabaseCredentialsResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **password** | **str** | Database password. Only used when the format is `\"database-export\"`. | [optional] 7 | **username** | **str** | Database user name. Only used when the format is `\"database-export\"`. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReportConfigDatabaseResource.md: -------------------------------------------------------------------------------- 1 | # ReportConfigDatabaseResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **credentials** | [**ReportConfigDatabaseCredentialsResource**](ReportConfigDatabaseCredentialsResource.md) | Credential information for the target database. Only used when the format is `\"database-export\"`. | [optional] 7 | **host** | **str** | The database server host to export to. | [optional] 8 | **name** | **str** | The name of the database to export to. | [optional] 9 | **port** | **int** | The database server port to export to. | [optional] 10 | **vendor** | **str** | The type of the database server. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ReportConfigFiltersResource.md: -------------------------------------------------------------------------------- 1 | # 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** | **str** | The vulnerability severities to include. Defaults to `all`. | [optional] 8 | **statuses** | **list[str]** | The vulnerability statuses to include. Defaults to [ `vulnerable`, `vulnerable-version`, `potentially-vulnerable` ]. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReportConfigScopeResource.md: -------------------------------------------------------------------------------- 1 | # ReportConfigScopeResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asset_groups** | **list[int]** | Identifiers of the asset groups in the scope of the report. | [optional] 7 | **assets** | **list[int]** | Identifiers of the assets in the scope of the report. | [optional] 8 | **scan** | **int** | Identifiers of the scans in the scope of the report. | [optional] 9 | **sites** | **list[int]** | Identifiers of the sites in the scope of the report. | [optional] 10 | **tags** | **list[int]** | Identifiers of the tags in the scope of the report. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ReportEmailSmtp.md: -------------------------------------------------------------------------------- 1 | # ReportEmailSmtp 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_global** | **bool** | Whether to use global SMTP settings. If enabled, `sender` and `relay` may not be specified. | [optional] 7 | **relay** | **str** | SMTP relay host or IP address. | [optional] 8 | **sender** | **str** | SMTP sender address. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ReportFilters.md: -------------------------------------------------------------------------------- 1 | # ReportFilters 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReportInstance.md: -------------------------------------------------------------------------------- 1 | # ReportInstance 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **generated** | **str** | The date the report finished generation. | [optional] 7 | **id** | **int** | The identifier of the report instance. | [optional] 8 | **links** | [**list[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** | **str** | The status of the report generation process. | [optional] 11 | **uri** | **str** | The URI of the report accessible through the web console. Refer to the `Download` relation hyperlink for a download URI. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/ReportScope.md: -------------------------------------------------------------------------------- 1 | # ReportScope 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReportSize.md: -------------------------------------------------------------------------------- 1 | # ReportSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReportStorage.md: -------------------------------------------------------------------------------- 1 | # ReportStorage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **location** | **str** | 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** | **str** | The full path to the additional copy storage location. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesAlert.md: -------------------------------------------------------------------------------- 1 | # ResourcesAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Alert]**](Alert.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesAssetGroup.md: -------------------------------------------------------------------------------- 1 | # ResourcesAssetGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[AssetGroup]**](AssetGroup.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesAssetTag.md: -------------------------------------------------------------------------------- 1 | # ResourcesAssetTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[AssetTag]**](AssetTag.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesAuthenticationSource.md: -------------------------------------------------------------------------------- 1 | # ResourcesAuthenticationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[AuthenticationSource]**](AuthenticationSource.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesAvailableReportFormat.md: -------------------------------------------------------------------------------- 1 | # ResourcesAvailableReportFormat 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[AvailableReportFormat]**](AvailableReportFormat.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesConfiguration.md: -------------------------------------------------------------------------------- 1 | # ResourcesConfiguration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Configuration]**](Configuration.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesDatabase.md: -------------------------------------------------------------------------------- 1 | # ResourcesDatabase 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Database]**](Database.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesDiscoveryAsset.md: -------------------------------------------------------------------------------- 1 | # ResourcesDiscoveryAsset 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | | [optional] 7 | **resources** | [**list[DiscoveryAsset]**](DiscoveryAsset.md) | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesEnginePool.md: -------------------------------------------------------------------------------- 1 | # ResourcesEnginePool 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[EnginePool]**](EnginePool.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesFile.md: -------------------------------------------------------------------------------- 1 | # ResourcesFile 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[File]**](File.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesGroupAccount.md: -------------------------------------------------------------------------------- 1 | # ResourcesGroupAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[GroupAccount]**](GroupAccount.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesMatchedSolution.md: -------------------------------------------------------------------------------- 1 | # ResourcesMatchedSolution 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[MatchedSolution]**](MatchedSolution.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesPolicyOverride.md: -------------------------------------------------------------------------------- 1 | # ResourcesPolicyOverride 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[PolicyOverride]**](PolicyOverride.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesReportInstance.md: -------------------------------------------------------------------------------- 1 | # ResourcesReportInstance 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[ReportInstance]**](ReportInstance.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesReportTemplate.md: -------------------------------------------------------------------------------- 1 | # ResourcesReportTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[ReportTemplate]**](ReportTemplate.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesRole.md: -------------------------------------------------------------------------------- 1 | # ResourcesRole 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Role]**](Role.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesScanEngine.md: -------------------------------------------------------------------------------- 1 | # ResourcesScanEngine 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[ScanEngine]**](ScanEngine.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesScanSchedule.md: -------------------------------------------------------------------------------- 1 | # ResourcesScanSchedule 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[ScanSchedule]**](ScanSchedule.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesScanTemplate.md: -------------------------------------------------------------------------------- 1 | # ResourcesScanTemplate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[ScanTemplate]**](ScanTemplate.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSharedCredential.md: -------------------------------------------------------------------------------- 1 | # ResourcesSharedCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SharedCredential]**](SharedCredential.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSiteCredential.md: -------------------------------------------------------------------------------- 1 | # ResourcesSiteCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SiteCredential]**](SiteCredential.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSiteSharedCredential.md: -------------------------------------------------------------------------------- 1 | # ResourcesSiteSharedCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SiteSharedCredential]**](SiteSharedCredential.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSmtpAlert.md: -------------------------------------------------------------------------------- 1 | # ResourcesSmtpAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SmtpAlert]**](SmtpAlert.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSnmpAlert.md: -------------------------------------------------------------------------------- 1 | # ResourcesSnmpAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SnmpAlert]**](SnmpAlert.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSoftware.md: -------------------------------------------------------------------------------- 1 | # ResourcesSoftware 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Software]**](Software.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSolution.md: -------------------------------------------------------------------------------- 1 | # ResourcesSolution 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Solution]**](Solution.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSonarQuery.md: -------------------------------------------------------------------------------- 1 | # ResourcesSonarQuery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SonarQuery]**](SonarQuery.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesSyslogAlert.md: -------------------------------------------------------------------------------- 1 | # ResourcesSyslogAlert 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[SyslogAlert]**](SyslogAlert.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesTag.md: -------------------------------------------------------------------------------- 1 | # ResourcesTag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[Tag]**](Tag.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesUser.md: -------------------------------------------------------------------------------- 1 | # ResourcesUser 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[User]**](User.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesUserAccount.md: -------------------------------------------------------------------------------- 1 | # ResourcesUserAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[UserAccount]**](UserAccount.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesVulnerabilityValidationResource.md: -------------------------------------------------------------------------------- 1 | # ResourcesVulnerabilityValidationResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[VulnerabilityValidationResource]**](VulnerabilityValidationResource.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesWebFormAuthentication.md: -------------------------------------------------------------------------------- 1 | # ResourcesWebFormAuthentication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[WebFormAuthentication]**](WebFormAuthentication.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ResourcesWebHeaderAuthentication.md: -------------------------------------------------------------------------------- 1 | # ResourcesWebHeaderAuthentication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[WebHeaderAuthentication]**](WebHeaderAuthentication.md) | The resources returned. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Review.md: -------------------------------------------------------------------------------- 1 | # Review 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **comment** | **str** | A comment from the reviewer detailing the review. | [optional] 7 | **_date** | **str** | The date and time the review took place. | [optional] 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | **name** | **str** | The identifier of the user that reviewed the vulnerability exception. | [optional] 10 | **user** | **int** | The login name of the user that reviewed the vulnerability exception. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RiskModifierSettings.md: -------------------------------------------------------------------------------- 1 | # RiskModifierSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **high** | **float** | High critical adjustment modifier. | [optional] 7 | **low** | **float** | Low critical adjustment modifier. | [optional] 8 | **medium** | **float** | Medium critical adjustment modifier. | [optional] 9 | **very_high** | **float** | Very high critical adjustment modifier. | [optional] 10 | **very_low** | **float** | Very low critical adjustment modifier. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RiskSettings.md: -------------------------------------------------------------------------------- 1 | # RiskSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **adjust_with_criticality** | **bool** | 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** | **str** | The risk model used to compute risk. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RiskTrendAllAssetsResource.md: -------------------------------------------------------------------------------- 1 | # RiskTrendAllAssetsResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **total** | **bool** | Includes a trend for the total risk of all assets. | [optional] 7 | **trend** | **str** | Whether to include a trend for average risk of all assets or the total number of assets. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Role.md: -------------------------------------------------------------------------------- 1 | # Role 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | The description of the role. | 7 | **id** | **str** | The identifier of the role. | 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **name** | **str** | The human readable name of the role. | 10 | **privileges** | **list[str]** | The privileges granted to the role. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ScanEvents.md: -------------------------------------------------------------------------------- 1 | # ScanEvents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **failed** | **bool** | Generates an alert when a scan fails. Default value is `false`. | 7 | **paused** | **bool** | Generates an alert when a scan pauses. Default value is `false`. | 8 | **resumed** | **bool** | Generates an alert when a scan resumes. Default value is `false`. | [optional] 9 | **started** | **bool** | Generates an alert when a scan starts. Default value is `false`. | 10 | **stopped** | **bool** | Generates an alert when a scan stops. Default value is `false`. | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ScanScope.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanSize.md: -------------------------------------------------------------------------------- 1 | # ScanSize 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bytes** | **int** | The raw value in bytes. | [optional] 7 | **formatted** | **str** | The value formatted in human-readable notation (e.g. GB, MB, KB, bytes). | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanTargetsResource.md: -------------------------------------------------------------------------------- 1 | # ScanTargetsResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **addresses** | **list[str]** | 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** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanTemplateDatabase.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateDatabase 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **db2** | **str** | Database name for DB2 database instance. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **oracle** | **list[str]** | Database name (SID) for an Oracle database instance. | [optional] 9 | **postgres** | **str** | Database name for PostgesSQL database instance. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscovery.md: -------------------------------------------------------------------------------- 1 | # 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformanceParallelism.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateDiscoveryPerformanceParallelism 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **maximum** | **int** | The maximum number of discovery connection requests send in parallel. Defaults to `0`. | [optional] 7 | **minimum** | **int** | The minimum number of discovery connection requests send in parallel. Defaults to `0`. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanTemplateDiscoveryPerformanceScanDelay.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateDiscoveryPerformanceScanDelay 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **maximum** | **str** | 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** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ScanTemplateServiceDiscovery.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateServiceDiscovery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **service_name_file** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateVulnerabilityCheckCategories.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateVulnerabilityCheckCategories 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **disabled** | **list[str]** | The categories of vulnerability checks to disable during a scan. | [optional] 7 | **enabled** | **list[str]** | The categories of vulnerability checks to enable during a scan. | [optional] 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateVulnerabilityCheckIndividual.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateVulnerabilityCheckIndividual 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **disabled** | **list[str]** | The individual vulnerability checks to disable during a scan. | [optional] 7 | **enabled** | **list[str]** | The individual vulnerability checks to enable during a scan. | [optional] 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateWebSpiderPaths.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateWebSpiderPaths 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **boostrap** | **str** | Paths to bootstrap spidering with. | [optional] 7 | **excluded** | **str** | Paths excluded from spidering. | [optional] 8 | **honor_robot_directives** | **bool** | Whether to honor robot directives. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/ScanTemplateWebSpiderPatterns.md: -------------------------------------------------------------------------------- 1 | # ScanTemplateWebSpiderPatterns 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **sensitive_content** | **str** | A regular expression that is used to find sensitive content on a page. | [optional] 7 | **sensitive_field** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SearchCriteria.md: -------------------------------------------------------------------------------- 1 | # SearchCriteria 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filters** | [**list[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** | **str** | 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 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ServiceUnavailableError.md: -------------------------------------------------------------------------------- 1 | # ServiceUnavailableError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **str** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **str** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SiteDiscoveryConnection.md: -------------------------------------------------------------------------------- 1 | # SiteDiscoveryConnection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the discovery connection. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **str** | The name of the discovery connection. | [optional] 9 | **type** | **str** | The type of discovery connection configured for the site. This property only applies to dynamic sites. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SiteSharedCredential.md: -------------------------------------------------------------------------------- 1 | # SiteSharedCredential 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **enabled** | **bool** | Flag indicating whether the shared credential is enabled for the site's scans. | [optional] 7 | **id** | **int** | The identifier of the shared credential. | [optional] 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **name** | **str** | The name of the shared credential. | [optional] 10 | **service** | **str** | The type of service the credential is configured to authenticate with. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SiteUpdateResource.md: -------------------------------------------------------------------------------- 1 | # SiteUpdateResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | The site's description. | [optional] 7 | **engine_id** | **int** | The identifier of a scan engine. | 8 | **importance** | **str** | The site importance. | 9 | **links** | [**list[Link]**](Link.md) | | [optional] 10 | **name** | **str** | The site name. Name must be unique. | 11 | **scan_template_id** | **str** | The identifier of a scan template. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SmtpSettings.md: -------------------------------------------------------------------------------- 1 | # SmtpSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **host** | **str** | The host to send to. | [optional] 7 | **port** | **int** | The port to send to. | [optional] 8 | **sender** | **str** | The sender to send from. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SonarCriteria.md: -------------------------------------------------------------------------------- 1 | # SonarCriteria 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filters** | [**list[SonarCriterion]**](SonarCriterion.md) | The filters in the Sonar query. | [optional] 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/SonarCriterion.md: -------------------------------------------------------------------------------- 1 | # SonarCriterion 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **days** | **int** | If the field is `scan-date-within-the-last`, the number of days to search against. | [optional] 7 | **domain** | **str** | If the field is `domain-contains`, the domain to search against. | [optional] 8 | **lower** | **str** | If the field is `ip-address-range`, the lower limit of the search. | [optional] 9 | **type** | **str** | The type of query to perform. | [optional] 10 | **upper** | **str** | If the field is `ip-address-range`, the upper limit of the search. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SonarQuery.md: -------------------------------------------------------------------------------- 1 | # 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** | **int** | The identifier of the Sonar query. | [optional] 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | **name** | **str** | The name of the Sonar query. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Steps.md: -------------------------------------------------------------------------------- 1 | # Steps 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **str** | Textual representation of the content. | [optional] 7 | **text** | **str** | Textual representation of the content. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Summary.md: -------------------------------------------------------------------------------- 1 | # Summary 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **html** | **str** | Textual representation of the content. | [optional] 7 | **text** | **str** | Textual representation of the content. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/SwaggerDiscoverySearchCriteriaFilter.md: -------------------------------------------------------------------------------- 1 | # SwaggerDiscoverySearchCriteriaFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field** | **str** | The filter field for the search criteria. | [optional] 7 | **lower** | **object** | The lower value to match in a range criteria. | [optional] 8 | **operator** | **str** | The operator on how to match the search criteria. | [optional] 9 | **upper** | **object** | The upper value to match in a range criteria. | [optional] 10 | **value** | **object** | The single value to match using the operator. | [optional] 11 | **values** | **list[object]** | An array of values to match using the operator. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SwaggerSearchCriteriaFilter.md: -------------------------------------------------------------------------------- 1 | # SwaggerSearchCriteriaFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field** | **str** | The filter field for the search criteria. | [optional] 7 | **lower** | **object** | The lower value to match in a range criteria. | [optional] 8 | **operator** | **str** | The operator on how to match the search criteria. | [optional] 9 | **upper** | **object** | The upper value to match in a range criteria. | [optional] 10 | **value** | **object** | The single value to match using the operator. | [optional] 11 | **values** | **list[object]** | An array of values to match using the operator. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Tag.md: -------------------------------------------------------------------------------- 1 | # Tag 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **color** | **str** | The color to use when rendering the tag in a user interface. | [optional] 7 | **created** | **str** | The date and time the tag was created. | [optional] 8 | **id** | **int** | The identifier of the tag. | [optional] 9 | **links** | [**list[Link]**](Link.md) | | [optional] 10 | **name** | **str** | 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** | **str** | The source of the tag. | [optional] 14 | **type** | **str** | The type of the tag. | 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/TagAssetSource.md: -------------------------------------------------------------------------------- 1 | # TagAssetSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | 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** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **source** | **str** | The source by which a tag applies to an asset. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TagLink.md: -------------------------------------------------------------------------------- 1 | # TagLink 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the tagged asset. | [optional] 7 | **sources** | **list[str]** | The source(s) by which a tag is-applied to an asset. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TaggedAssetReferences.md: -------------------------------------------------------------------------------- 1 | # TaggedAssetReferences 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **resources** | [**list[TagLink]**](TagLink.md) | The identifiers of the associated resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Telnet.md: -------------------------------------------------------------------------------- 1 | # Telnet 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **character_set** | **str** | The character set to use. | [optional] 7 | **failed_login_regex** | **str** | Regular expression to match a failed login response. | [optional] 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | **login_regex** | **str** | Regular expression to match a login response. | [optional] 10 | **password_prompt_regex** | **str** | Regular expression to match a password prompt. | [optional] 11 | **questionable_login_regex** | **str** | Regular expression to match a potential false negative login response. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/TokenResource.md: -------------------------------------------------------------------------------- 1 | # TokenResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **str** | The two-factor authentication token seed (key). | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UnauthorizedError.md: -------------------------------------------------------------------------------- 1 | # UnauthorizedError 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 7 | **message** | **str** | The messages indicating the cause or reason for failure. | [optional] 8 | **status** | **str** | The HTTP status code for the error (same as in the HTTP response). | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UniqueId.md: -------------------------------------------------------------------------------- 1 | # UniqueId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | The unique identifier. | 7 | **source** | **str** | The source of the unique identifier. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateId.md: -------------------------------------------------------------------------------- 1 | # UpdateId 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **product_id** | **str** | Product update identifier. | [optional] 7 | **version_id** | **str** | Version update identifier. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UpdateInfo.md: -------------------------------------------------------------------------------- 1 | # UpdateInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content** | **str** | The most recent content update. | [optional] 7 | **content_partial** | **str** | The most recent, partially-applied (in-memory), content update. | [optional] 8 | **id** | [**UpdateId**](UpdateId.md) | Details of update identifiers. | [optional] 9 | **product** | **str** | The most recent product update. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UpdateSettings.md: -------------------------------------------------------------------------------- 1 | # UpdateSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content_auto_update** | **bool** | Whether automatic content updates are enabled. | [optional] 7 | **enabled** | **bool** | Whether updates are enabled. | [optional] 8 | **product_auto_update** | **bool** | Whether automatic product updates are enabled. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UserAccount.md: -------------------------------------------------------------------------------- 1 | # UserAccount 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **full_name** | **str** | The full name of the user account. | [optional] 7 | **id** | **int** | The identifier of the user account. | [optional] 8 | **name** | **str** | The name of the user account. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UserCreateRole.md: -------------------------------------------------------------------------------- 1 | # UserCreateRole 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **all_asset_groups** | **bool** | Whether to grant the user access to all asset groups. Defaults to `false`. | [optional] 7 | **all_sites** | **bool** | Whether to grant the user access to all sites. Defaults to `false`. | [optional] 8 | **id** | **str** | The identifier of the role the user is assigned to. | 9 | **superuser** | **bool** | Whether the user is a superuser. Defaults to `false`. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UserRole.md: -------------------------------------------------------------------------------- 1 | # UserRole 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **all_asset_groups** | **bool** | Whether the user has access to all asset groups. | [optional] 7 | **all_sites** | **bool** | Whether the user has access to all sites. | [optional] 8 | **id** | **str** | The identifier of the role the user is assigned to. | [optional] 9 | **name** | **str** | The name of the role the user is assigned to. | [optional] 10 | **privileges** | **list[str]** | The privileges granted to the user by their role. | [optional] 11 | **superuser** | **bool** | Whether the user is a superuser. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/VersionInfo.md: -------------------------------------------------------------------------------- 1 | # VersionInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **build** | **str** | The build number. | [optional] 7 | **changeset** | **str** | The changeset of the source build. | [optional] 8 | **platform** | **str** | The platform of the build. | [optional] 9 | **semantic** | **str** | The semantic version number of the installation. | [optional] 10 | **update** | [**UpdateInfo**](UpdateInfo.md) | Version update details. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Vulnerabilities.md: -------------------------------------------------------------------------------- 1 | # Vulnerabilities 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **critical** | **int** | The number of critical vulnerabilities. | [optional] 7 | **moderate** | **int** | The number of moderate vulnerabilities. | [optional] 8 | **severe** | **int** | The number of severe vulnerabilities. | [optional] 9 | **total** | **int** | The total number of vulnerabilities. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/VulnerabilityCategory.md: -------------------------------------------------------------------------------- 1 | # VulnerabilityCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the vulnerability category. | [optional] 7 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 8 | **name** | **str** | The name of the category. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/VulnerabilityCheckType.md: -------------------------------------------------------------------------------- 1 | # VulnerabilityCheckType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **disabled** | **list[str]** | The types of vulnerability checks to disable during a scan. | [optional] 7 | **enabled** | **list[str]** | The types of vulnerability checks to enable during a scan. | [optional] 8 | **links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/VulnerabilityValidationResource.md: -------------------------------------------------------------------------------- 1 | # VulnerabilityValidationResource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_date** | **str** | The date and time the vulnerability was validated, in the ISO8601 format. | [optional] 7 | **id** | **int** | The identifier of the vulnerability validation. | [optional] 8 | **links** | [**list[Link]**](Link.md) | | [optional] 9 | **source** | [**VulnerabilityValidationSource**](VulnerabilityValidationSource.md) | The source used to validate the vulnerability. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/VulnerabilityValidationSource.md: -------------------------------------------------------------------------------- 1 | # VulnerabilityValidationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **key** | **str** | The identifier or name of the exploit that was used to validate the vulnerability. | [optional] 7 | **name** | **str** | The name of the source used to validate the vulnerability. | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/WebApplication.md: -------------------------------------------------------------------------------- 1 | # WebApplication 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **int** | The identifier of the web application. | [optional] 7 | **pages** | [**list[WebPage]**](WebPage.md) | The pages discovered on the web application. | [optional] 8 | **root** | **str** | The web root of the web application. | [optional] 9 | **virtual_host** | **str** | The virtual host of the web application. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/WebPage.md: -------------------------------------------------------------------------------- 1 | # WebPage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **link_type** | **str** | The type of link used to traverse or detect the page. | [optional] 7 | **path** | **str** | The path to the page (URI). | [optional] 8 | **response** | **int** | The HTTP response code observed with retrieving the page. | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/WebSettings.md: -------------------------------------------------------------------------------- 1 | # WebSettings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **max_threads** | **int** | The maximum number of request handling threads. | [optional] 7 | **min_threads** | **int** | The minimum number of request handling threads. | [optional] 8 | **port** | **int** | The port the web server is accepting requests. | [optional] 9 | **session_timeout** | **str** | Session timeout duration, in ISO 8601 format. For example: `\"PT10M\"`. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi >= 14.05.14 2 | six >= 1.10 3 | python_dateutil >= 2.5.3 4 | setuptools >= 21.0.0 5 | urllib3 >= 1.15.1 6 | -------------------------------------------------------------------------------- /setup_workspace/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "packageName": "rapid7vmconsole", 3 | "projectName": "rapid7_vm_console", 4 | "packageVersion": "6.6.55", 5 | "packageUrl": "https://github.com/rapid7/vm-console-client-python" 6 | } 7 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | coverage>=4.0.3 2 | nose>=1.3.7 3 | pluggy>=0.3.1 4 | py>=1.4.31 5 | randomize>=0.13 6 | -------------------------------------------------------------------------------- /test/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rapid7/vm-console-client-python/ae2af799bcbbf1362755d4b1b4f52ce5459905b7/test/__init__.py -------------------------------------------------------------------------------- /test/test_account.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.account import Account # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestAccount(unittest.TestCase): 22 | """Account unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testAccount(self): 31 | """Test Account""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.account.Account() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_address.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.address import Address # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestAddress(unittest.TestCase): 22 | """Address unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testAddress(self): 31 | """Test Address""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.address.Address() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_agent.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import rapid7vmconsole 17 | from rapid7vmconsole.models.agent import Agent # noqa: E501 18 | from rapid7vmconsole.rest import ApiException 19 | 20 | 21 | class TestAgent(unittest.TestCase): 22 | """Agent unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testAgent(self): 31 | """Test Agent""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = rapid7vmconsole.models.agent.Agent() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_alert.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.alert import Alert # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestAlert(unittest.TestCase): 22 | """Alert unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testAlert(self): 31 | """Test Alert""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.alert.Alert() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_asset.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.asset import Asset # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestAsset(unittest.TestCase): 22 | """Asset unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testAsset(self): 31 | """Test Asset""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.asset.Asset() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_asset_tag.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.asset_tag import AssetTag # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestAssetTag(unittest.TestCase): 22 | """AssetTag unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testAssetTag(self): 31 | """Test AssetTag""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.asset_tag.AssetTag() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_cpu_info.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.cpu_info import CPUInfo # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestCPUInfo(unittest.TestCase): 22 | """CPUInfo unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testCPUInfo(self): 31 | """Test CPUInfo""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.cpu_info.CPUInfo() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_database.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.database import Database # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestDatabase(unittest.TestCase): 22 | """Database unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testDatabase(self): 31 | """Test Database""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.database.Database() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_disk_free.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.disk_free import DiskFree # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestDiskFree(unittest.TestCase): 22 | """DiskFree unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testDiskFree(self): 31 | """Test DiskFree""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.disk_free.DiskFree() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_disk_info.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.disk_info import DiskInfo # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestDiskInfo(unittest.TestCase): 22 | """DiskInfo unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testDiskInfo(self): 31 | """Test DiskInfo""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.disk_info.DiskInfo() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_error.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.error import Error # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestError(unittest.TestCase): 22 | """Error unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testError(self): 31 | """Test Error""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.error.Error() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_exploit.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.exploit import Exploit # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestExploit(unittest.TestCase): 22 | """Exploit unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testExploit(self): 31 | """Test Exploit""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.exploit.Exploit() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_features.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.features import Features # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestFeatures(unittest.TestCase): 22 | """Features unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testFeatures(self): 31 | """Test Features""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.features.Features() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_file.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.file import File # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestFile(unittest.TestCase): 22 | """File unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testFile(self): 31 | """Test File""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.file.File() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_host_name.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.host_name import HostName # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestHostName(unittest.TestCase): 22 | """HostName unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testHostName(self): 31 | """Test HostName""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.host_name.HostName() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_info.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.info import Info # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestInfo(unittest.TestCase): 22 | """Info unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testInfo(self): 31 | """Test Info""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.info.Info() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_json_node.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.json_node import JsonNode # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestJsonNode(unittest.TestCase): 22 | """JsonNode unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testJsonNode(self): 31 | """Test JsonNode""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.json_node.JsonNode() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_jvm_info.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.jvm_info import JVMInfo # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestJVMInfo(unittest.TestCase): 22 | """JVMInfo unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testJVMInfo(self): 31 | """Test JVMInfo""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.jvm_info.JVMInfo() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_license.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.license import License # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestLicense(unittest.TestCase): 22 | """License unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testLicense(self): 31 | """Test License""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.license.License() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_link.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.link import Link # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestLink(unittest.TestCase): 22 | """Link unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testLink(self): 31 | """Test Link""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.link.Link() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_links.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.links import Links # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestLinks(unittest.TestCase): 22 | """Links unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testLinks(self): 31 | """Test Links""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.links.Links() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_page_info.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.page_info import PageInfo # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestPageInfo(unittest.TestCase): 22 | """PageInfo unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testPageInfo(self): 31 | """Test PageInfo""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.page_info.PageInfo() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_pci.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.pci import PCI # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestPCI(unittest.TestCase): 22 | """PCI unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testPCI(self): 31 | """Test PCI""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.pci.PCI() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_policy.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.policy import Policy # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestPolicy(unittest.TestCase): 22 | """Policy unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testPolicy(self): 31 | """Test Policy""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.policy.Policy() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_repeat.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import rapid7vmconsole 17 | from rapid7vmconsole.models.repeat import Repeat # noqa: E501 18 | from rapid7vmconsole.rest import ApiException 19 | 20 | 21 | class TestRepeat(unittest.TestCase): 22 | """Repeat unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testRepeat(self): 31 | """Test Repeat""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = rapid7vmconsole.models.repeat.Repeat() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_report.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.report import Report # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestReport(unittest.TestCase): 22 | """Report unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testReport(self): 31 | """Test Report""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.report.Report() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_review.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.review import Review # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestReview(unittest.TestCase): 22 | """Review unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testReview(self): 31 | """Test Review""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.review.Review() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_role.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.role import Role # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestRole(unittest.TestCase): 22 | """Role unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testRole(self): 31 | """Test Role""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.role.Role() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_root_api.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.api.root_api import RootApi # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestRootApi(unittest.TestCase): 22 | """RootApi unit test stubs""" 23 | 24 | def setUp(self): 25 | self.api = swagger_client.api.root_api.RootApi() # noqa: E501 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def test_resources(self): 31 | """Test case for resources 32 | 33 | Resources # noqa: E501 34 | """ 35 | pass 36 | 37 | 38 | if __name__ == '__main__': 39 | unittest.main() 40 | -------------------------------------------------------------------------------- /test/test_scan.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.scan import Scan # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestScan(unittest.TestCase): 22 | """Scan unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testScan(self): 31 | """Test Scan""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.scan.Scan() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_scan_size.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.scan_size import ScanSize # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestScanSize(unittest.TestCase): 22 | """ScanSize unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testScanSize(self): 31 | """Test ScanSize""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.scan_size.ScanSize() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_service.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.service import Service # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestService(unittest.TestCase): 22 | """Service unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testService(self): 31 | """Test Service""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.service.Service() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_settings.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.settings import Settings # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestSettings(unittest.TestCase): 22 | """Settings unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testSettings(self): 31 | """Test Settings""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.settings.Settings() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_site.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.site import Site # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestSite(unittest.TestCase): 22 | """Site unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testSite(self): 31 | """Test Site""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.site.Site() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_software.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.software import Software # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestSoftware(unittest.TestCase): 22 | """Software unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testSoftware(self): 31 | """Test Software""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.software.Software() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_solution.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.solution import Solution # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestSolution(unittest.TestCase): 22 | """Solution unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testSolution(self): 31 | """Test Solution""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.solution.Solution() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_steps.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.steps import Steps # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestSteps(unittest.TestCase): 22 | """Steps unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testSteps(self): 31 | """Test Steps""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.steps.Steps() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_summary.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.summary import Summary # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestSummary(unittest.TestCase): 22 | """Summary unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testSummary(self): 31 | """Test Summary""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.summary.Summary() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_tag.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.tag import Tag # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestTag(unittest.TestCase): 22 | """Tag unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testTag(self): 31 | """Test Tag""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.tag.Tag() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_tag_link.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.tag_link import TagLink # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestTagLink(unittest.TestCase): 22 | """TagLink unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testTagLink(self): 31 | """Test TagLink""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.tag_link.TagLink() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_telnet.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.telnet import Telnet # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestTelnet(unittest.TestCase): 22 | """Telnet unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testTelnet(self): 31 | """Test Telnet""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.telnet.Telnet() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_user.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.user import User # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestUser(unittest.TestCase): 22 | """User unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testUser(self): 31 | """Test User""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.user.User() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /test/test_web_page.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Python InsightVM API Client 5 | 6 | OpenAPI spec version: 3 7 | Contact: support@rapid7.com 8 | Generated by: https://github.com/swagger-api/swagger-codegen.git 9 | """ 10 | 11 | 12 | from __future__ import absolute_import 13 | 14 | import unittest 15 | 16 | import swagger_client 17 | from swagger_client.models.web_page import WebPage # noqa: E501 18 | from swagger_client.rest import ApiException 19 | 20 | 21 | class TestWebPage(unittest.TestCase): 22 | """WebPage unit test stubs""" 23 | 24 | def setUp(self): 25 | pass 26 | 27 | def tearDown(self): 28 | pass 29 | 30 | def testWebPage(self): 31 | """Test WebPage""" 32 | # FIXME: construct object with mandatory attributes with example values 33 | # model = swagger_client.models.web_page.WebPage() # noqa: E501 34 | pass 35 | 36 | 37 | if __name__ == '__main__': 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | nosetests \ 10 | [] 11 | --------------------------------------------------------------------------------