No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This Python package is automatically generated by the Swagger Codegen project:
- API version: 3
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import swagger_client Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import swagger_clientPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: Basic
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
license = 'license_example' # str | (optional)
key = 'key_example' # str | A license activation key. (optional)
try:
# License
api_response = api_instance.activate_license(license=license, key=key)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->activate_license: %s\n" % e)
# Configure HTTP basic authorization: Basic
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
body = 'body_example' # str | The console command to execute. (optional)
try:
# Console Commands
api_response = api_instance.execute_command(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->execute_command: %s\n" % e)
# Configure HTTP basic authorization: Basic
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
try:
# Information
api_response = api_instance.get_info()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->get_info: %s\n" % e)
# Configure HTTP basic authorization: Basic
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
try:
# License
api_response = api_instance.get_license()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->get_license: %s\n" % e)
# Configure HTTP basic authorization: Basic
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
try:
# Properties
api_response = api_instance.get_properties()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->get_properties: %s\n" % e)
# Configure HTTP basic authorization: Basic
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdministrationApi(swagger_client.ApiClient(configuration))
try:
# Settings
api_response = api_instance.get_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdministrationApi->get_settings: %s\n" % e)All URIs are relative to /
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdministrationApi | activate_license | POST /api/3/administration/license | License |
| AdministrationApi | execute_command | POST /api/3/administration/commands | Console Commands |
| AdministrationApi | get_info | GET /api/3/administration/info | Information |
| AdministrationApi | get_license | GET /api/3/administration/license | License |
| AdministrationApi | get_properties | GET /api/3/administration/properties | Properties |
| AdministrationApi | get_settings | GET /api/3/administration/settings | Settings |
| AssetApi | add_asset_tag | PUT /api/3/assets/{id}/tags/{tagId} | Asset Tag |
| AssetApi | create_asset | POST /api/3/sites/{id}/assets | Assets |
| AssetApi | delete_asset | DELETE /api/3/assets/{id} | Asset |
| AssetApi | find_assets | POST /api/3/assets/search | Asset Search |
| AssetApi | get_asset | GET /api/3/assets/{id} | Asset |
| AssetApi | get_asset_databases | GET /api/3/assets/{id}/databases | Asset Databases |
| AssetApi | get_asset_files | GET /api/3/assets/{id}/files | Asset Files |
| AssetApi | get_asset_service | GET /api/3/assets/{id}/services/{protocol}/{port} | Asset Service |
| AssetApi | get_asset_service_configurations | GET /api/3/assets/{id}/services/{protocol}/{port}/configurations | Asset Service Configurations |
| AssetApi | get_asset_service_databases | GET /api/3/assets/{id}/services/{protocol}/{port}/databases | Asset Service Databases |
| AssetApi | get_asset_service_user_groups | GET /api/3/assets/{id}/services/{protocol}/{port}/user_groups | Asset Service User Groups |
| AssetApi | get_asset_service_users | GET /api/3/assets/{id}/services/{protocol}/{port}/users | Asset Service Users |
| AssetApi | get_asset_service_web_application | GET /api/3/assets/{id}/services/{protocol}/{port}/web_applications/{webApplicationId} | Asset Service Web Application |
| AssetApi | get_asset_service_web_applications | GET /api/3/assets/{id}/services/{protocol}/{port}/web_applications | Asset Service Web Applications |
| AssetApi | get_asset_services | GET /api/3/assets/{id}/services | Asset Services |
| AssetApi | get_asset_software | GET /api/3/assets/{id}/software | Asset Software |
| AssetApi | get_asset_tags | GET /api/3/assets/{id}/tags | Asset Tags |
| AssetApi | get_asset_user_groups | GET /api/3/assets/{id}/user_groups | Asset User Groups |
| AssetApi | get_asset_users | GET /api/3/assets/{id}/users | Asset Users |
| AssetApi | get_assets | GET /api/3/assets | Assets |
| AssetApi | get_operating_system | GET /api/3/operating_systems/{id} | Operating System |
| AssetApi | get_operating_systems | GET /api/3/operating_systems | Operating Systems |
| AssetApi | get_software | GET /api/3/software/{id} | Software |
| AssetApi | get_softwares | GET /api/3/software | Software |
| AssetApi | remove_asset_tag | DELETE /api/3/assets/{id}/tags/{tagId} | Asset Tag |
| AssetDiscoveryApi | create_sonar_query | POST /api/3/sonar_queries | Sonar Queries |
| AssetDiscoveryApi | delete_sonar_query | DELETE /api/3/sonar_queries/{id} | Sonar Query |
| AssetDiscoveryApi | get_discovery_connection | GET /api/3/discovery_connections/{id} | Discovery Connection |
| AssetDiscoveryApi | get_discovery_connections | GET /api/3/discovery_connections | Discovery Connections |
| AssetDiscoveryApi | get_sonar_queries | GET /api/3/sonar_queries | Sonar Queries |
| AssetDiscoveryApi | get_sonar_query | GET /api/3/sonar_queries/{id} | Sonar Query |
| AssetDiscoveryApi | get_sonar_query_assets | GET /api/3/sonar_queries/{id}/assets | Sonar Query Assets |
| AssetDiscoveryApi | reconnect_discovery_connection | POST /api/3/discovery_connections/{id}/connect | Discovery Connection Reconnect |
| AssetDiscoveryApi | sonar_query_search | POST /api/3/sonar_queries/search | Sonar Query Search |
| AssetDiscoveryApi | update_sonar_query | PUT /api/3/sonar_queries/{id} | Sonar Query |
| AssetGroupApi | add_asset_group_tag | PUT /api/3/asset_groups/{id}/tags/{tagId} | Asset Group Tag |
| AssetGroupApi | add_asset_group_user | PUT /api/3/asset_groups/{id}/users/{userId} | Asset Group User |
| AssetGroupApi | add_asset_to_asset_group | PUT /api/3/asset_groups/{id}/assets/{assetId} | Asset Group Asset |
| AssetGroupApi | create_asset_group | POST /api/3/asset_groups | Asset Groups |
| AssetGroupApi | delete_asset_group | DELETE /api/3/asset_groups/{id} | Asset Group |
| AssetGroupApi | get_asset_group | GET /api/3/asset_groups/{id} | Asset Group |
| AssetGroupApi | get_asset_group_assets | GET /api/3/asset_groups/{id}/assets | Asset Group Assets |
| AssetGroupApi | get_asset_group_search_criteria | GET /api/3/asset_groups/{id}/search_criteria | Asset Group Search Criteria |
| AssetGroupApi | get_asset_group_tags | GET /api/3/asset_groups/{id}/tags | Asset Group Tags |
| AssetGroupApi | get_asset_group_users | GET /api/3/asset_groups/{id}/users | Asset Group Users |
| AssetGroupApi | get_asset_groups | GET /api/3/asset_groups | Asset Groups |
| AssetGroupApi | remove_all_asset_group_tags | DELETE /api/3/asset_groups/{id}/tags | Asset Group Tags |
| AssetGroupApi | remove_all_assets_from_asset_group | DELETE /api/3/asset_groups/{id}/assets | Asset Group Assets |
| AssetGroupApi | remove_asset_from_asset_group | DELETE /api/3/asset_groups/{id}/assets/{assetId} | Asset Group Asset |
| AssetGroupApi | remove_asset_group_tag | DELETE /api/3/asset_groups/{id}/tags/{tagId} | Asset Group Tag |
| AssetGroupApi | remove_asset_group_user | DELETE /api/3/asset_groups/{id}/users/{userId} | Asset Group User |
| AssetGroupApi | set_asset_group_search_criteria | PUT /api/3/asset_groups/{id}/search_criteria | Asset Group Search Criteria |
| AssetGroupApi | set_asset_group_tags | PUT /api/3/asset_groups/{id}/tags | Asset Group Tags |
| AssetGroupApi | set_asset_group_users | PUT /api/3/asset_groups/{id}/users | Asset Group Users |
| AssetGroupApi | update_asset_group | PUT /api/3/asset_groups/{id} | Asset Group |
| AssetGroupApi | update_asset_group_assets | PUT /api/3/asset_groups/{id}/assets | Asset Group Assets |
| CredentialApi | create_shared_credential | POST /api/3/shared_credentials | Shared Credentials |
| CredentialApi | delete_all_shared_credentials | DELETE /api/3/shared_credentials | Shared Credentials |
| CredentialApi | delete_shared_credential | DELETE /api/3/shared_credentials/{id} | Shared Credential |
| CredentialApi | get_shared_credential | GET /api/3/shared_credentials/{id} | Shared Credential |
| CredentialApi | get_shared_credentials | GET /api/3/shared_credentials | Shared Credentials |
| CredentialApi | update_shared_credential | PUT /api/3/shared_credentials/{id} | Shared Credential |
| PolicyApi | get_asset_policy_children | GET /api/3/assets/{assetId}/policies/{policyId}/children | Policy Rules or Groups Directly Under Policy For Asset |
| PolicyApi | get_asset_policy_group_children | GET /api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/children | Policy Rules or Groups Directly Under Policy Group For Asset |
| PolicyApi | get_asset_policy_rules_summary | GET /api/3/assets/{assetId}/policies/{policyId}/rules | Policy Rules For Asset |
| PolicyApi | get_descendant_policy_rules | GET /api/3/policies/{policyId}/groups/{groupId}/rules | Policy Rules Under Policy Group |
| PolicyApi | get_disabled_policy_rules | GET /api/3/policies/{policyId}/rules/disabled | Disabled Policy Rules |
| PolicyApi | get_policies | GET /api/3/policies | Policies |
| PolicyApi | get_policies_for_asset | GET /api/3/assets/{assetId}/policies | Policies For Asset |
| PolicyApi | get_policy | GET /api/3/policies/{policyId} | Policy |
| PolicyApi | get_policy_asset_result | GET /api/3/policies/{policyId}/assets/{assetId} | Policy Asset Result |
| PolicyApi | get_policy_asset_results | GET /api/3/policies/{policyId}/assets | Policy Asset Results |
| PolicyApi | get_policy_children | GET /api/3/policies/{id}/children | Policy Rules or Groups Directly Under Policy |
| PolicyApi | get_policy_group | GET /api/3/policies/{policyId}/groups/{groupId} | Policy Group |
| PolicyApi | get_policy_group_asset_result | GET /api/3/policies/{policyId}/groups/{groupId}/assets/{assetId} | Asset Compliance For Policy Rules Under Policy Group |
| PolicyApi | get_policy_group_asset_results | GET /api/3/policies/{policyId}/groups/{groupId}/assets | Assets Compliance For Policy Rules Under Policy Group |
| PolicyApi | get_policy_group_children | GET /api/3/policies/{policyId}/groups/{groupId}/children | Policy Rules or Groups Directly Under Policy Group |
| PolicyApi | get_policy_group_rules_with_asset_assessment | GET /api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/rules | Policy Rules Under Policy Group For Asset |
| PolicyApi | get_policy_groups | GET /api/3/policies/{policyId}/groups | Policy Groups |
| PolicyApi | get_policy_rule | GET /api/3/policies/{policyId}/rules/{ruleId} | Policy Rule |
| PolicyApi | get_policy_rule_asset_result | GET /api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId} | Asset Compliance For Policy Rule |
| PolicyApi | get_policy_rule_asset_result_proof | GET /api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}/proof | Policy Rule Proof For Asset |
| PolicyApi | get_policy_rule_asset_results | GET /api/3/policies/{policyId}/rules/{ruleId}/assets | Assets Compliance For Policy Rule |
| PolicyApi | get_policy_rule_controls | GET /api/3/policies/{policyId}/rules/{ruleId}/controls | Policy Rule Controls |
| PolicyApi | get_policy_rule_rationale | GET /api/3/policies/{policyId}/rules/{ruleId}/rationale | Policy Rule Rationale |
| PolicyApi | get_policy_rule_remediation | GET /api/3/policies/{policyId}/rules/{ruleId}/remediation | Policy Rule Remediation |
| PolicyApi | get_policy_rules | GET /api/3/policies/{policyId}/rules | Policy Rules |
| PolicyApi | get_policy_summary | GET /api/3/policy/summary | Policy Compliance Summaries |
| PolicyOverrideApi | create_policy_override | POST /api/3/policy_overrides | Policy Overrides |
| PolicyOverrideApi | delete_policy_override | DELETE /api/3/policy_overrides/{id} | Policy Override |
| PolicyOverrideApi | get_asset_policy_overrides | GET /api/3/assets/{id}/policy_overrides | Asset Policy Overrides |
| PolicyOverrideApi | get_policy_override | GET /api/3/policy_overrides/{id} | Policy Override |
| PolicyOverrideApi | get_policy_override_expiration | GET /api/3/policy_overrides/{id}/expires | Policy Override Expiration |
| PolicyOverrideApi | get_policy_overrides | GET /api/3/policy_overrides | Policy Overrides |
| PolicyOverrideApi | set_policy_override_expiration | PUT /api/3/policy_overrides/{id}/expires | Policy Override Expiration |
| PolicyOverrideApi | set_policy_override_status | POST /api/3/policy_overrides/{id}/{status} | Policy Override Status |
| RemediationApi | get_asset_vulnerability_solutions | GET /api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/solution | Asset Vulnerability Solution |
| ReportApi | create_report | POST /api/3/reports | Reports |
| ReportApi | delete_report | DELETE /api/3/reports/{id} | Report |
| ReportApi | delete_report_instance | DELETE /api/3/reports/{id}/history/{instance} | Report History |
| ReportApi | download_report | GET /api/3/reports/{id}/history/{instance}/output | Report Download |
| ReportApi | generate_report | POST /api/3/reports/{id}/generate | Report Generation |
| ReportApi | get_report | GET /api/3/reports/{id} | Report |
| ReportApi | get_report_formats | GET /api/3/report_formats | Report Formats |
| ReportApi | get_report_instance | GET /api/3/reports/{id}/history/{instance} | Report History |
| ReportApi | get_report_instances | GET /api/3/reports/{id}/history | Report Histories |
| ReportApi | get_report_template | GET /api/3/report_templates/{id} | Report Template |
| ReportApi | get_report_templates | GET /api/3/report_templates | Report Templates |
| ReportApi | get_reports | GET /api/3/reports | Reports |
| ReportApi | update_report | PUT /api/3/reports/{id} | Report |
| RootApi | resources | GET /api/3 | Resources |
| ScanApi | get_scan | GET /api/3/scans/{id} | Scan |
| ScanApi | get_scans | GET /api/3/scans | Scans |
| ScanApi | get_site_scans | GET /api/3/sites/{id}/scans | Site Scans |
| ScanApi | set_scan_status | POST /api/3/scans/{id}/{status} | Scan Status |
| ScanApi | start_scan | POST /api/3/sites/{id}/scans | Site Scans |
| ScanEngineApi | add_scan_engine_pool_scan_engine | PUT /api/3/scan_engine_pools/{id}/engines/{engineId} | Engine Pool Engines |
| ScanEngineApi | create_scan_engine | POST /api/3/scan_engines | Scan Engines |
| ScanEngineApi | create_scan_engine_pool | POST /api/3/scan_engine_pools | Engine Pools |
| ScanEngineApi | delete_scan_engine | DELETE /api/3/scan_engines/{id} | Scan Engine |
| ScanEngineApi | get_assigned_engine_pools | GET /api/3/scan_engines/{id}/scan_engine_pools | Assigned Engine Pools |
| ScanEngineApi | get_engine_pool | GET /api/3/scan_engine_pools/{id} | Engine Pool |
| ScanEngineApi | get_scan_engine | GET /api/3/scan_engines/{id} | Scan Engine |
| ScanEngineApi | get_scan_engine_pool_scan_engines | GET /api/3/scan_engine_pools/{id}/engines | Engine Pool Engines |
| ScanEngineApi | get_scan_engine_pool_sites | GET /api/3/scan_engine_pools/{id}/sites | Engine Pool Sites |
| ScanEngineApi | get_scan_engine_pools | GET /api/3/scan_engine_pools | Engine Pools |
| ScanEngineApi | get_scan_engine_scans | GET /api/3/scan_engines/{id}/scans | Scan Engine Scans |
| ScanEngineApi | get_scan_engine_sites | GET /api/3/scan_engines/{id}/sites | Scan Engine Sites |
| ScanEngineApi | get_scan_engines | GET /api/3/scan_engines | Scan Engines |
| ScanEngineApi | remove_scan_engine_pool | DELETE /api/3/scan_engine_pools/{id} | Engine Pool |
| ScanEngineApi | remove_scan_engine_pool_scan_engine | DELETE /api/3/scan_engine_pools/{id}/engines/{engineId} | Engine Pool Engines |
| ScanEngineApi | set_scan_engine_pool_scan_engines | PUT /api/3/scan_engine_pools/{id}/engines | Engine Pool Engines |
| ScanEngineApi | update_scan_engine | PUT /api/3/scan_engines/{id} | Scan Engine |
| ScanEngineApi | update_scan_engine_pool | PUT /api/3/scan_engine_pools/{id} | Engine Pool |
| ScanTemplateApi | create_scan_template | POST /api/3/scan_templates | Scan Templates |
| ScanTemplateApi | delete_scan_template | DELETE /api/3/scan_templates/{id} | Scan Template |
| ScanTemplateApi | get_scan_template | GET /api/3/scan_templates/{id} | Scan Template |
| ScanTemplateApi | get_scan_templates | GET /api/3/scan_templates | Scan Templates |
| ScanTemplateApi | update_scan_template | PUT /api/3/scan_templates/{id} | Scan Template |
| SiteApi | add_site_tag | PUT /api/3/sites/{id}/tags/{tagId} | Site Tag |
| SiteApi | add_site_user | POST /api/3/sites/{id}/users | Site Users Access |
| SiteApi | create_site | POST /api/3/sites | Sites |
| SiteApi | create_site_credential | POST /api/3/sites/{id}/site_credentials | Site Scan Credentials |
| SiteApi | create_site_scan_schedule | POST /api/3/sites/{id}/scan_schedules | Site Scan Schedules |
| SiteApi | create_site_smtp_alert | POST /api/3/sites/{id}/alerts/smtp | Site SMTP Alerts |
| SiteApi | create_site_snmp_alert | POST /api/3/sites/{id}/alerts/snmp | Site SNMP Alerts |
| SiteApi | create_site_syslog_alert | POST /api/3/sites/{id}/alerts/syslog | Site Syslog Alerts |
| SiteApi | delete_all_site_alerts | DELETE /api/3/sites/{id}/alerts | Site Alerts |
| SiteApi | delete_all_site_credentials | DELETE /api/3/sites/{id}/site_credentials | Site Scan Credentials |
| SiteApi | delete_all_site_scan_schedules | DELETE /api/3/sites/{id}/scan_schedules | Site Scan Schedules |
| SiteApi | delete_all_site_smtp_alerts | DELETE /api/3/sites/{id}/alerts/smtp | Site SMTP Alerts |
| SiteApi | delete_all_site_snmp_alerts | DELETE /api/3/sites/{id}/alerts/snmp | Site SNMP Alerts |
| SiteApi | delete_all_site_syslog_alerts | DELETE /api/3/sites/{id}/alerts/syslog | Site Syslog Alerts |
| SiteApi | delete_site | DELETE /api/3/sites/{id} | Site |
| SiteApi | delete_site_credential | DELETE /api/3/sites/{id}/site_credentials/{credentialId} | Site Scan Credential |
| SiteApi | delete_site_scan_schedule | DELETE /api/3/sites/{id}/scan_schedules/{scheduleId} | Site Scan Schedule |
| SiteApi | delete_site_smtp_alert | DELETE /api/3/sites/{id}/alerts/smtp/{alertId} | Site SMTP Alert |
| SiteApi | delete_site_snmp_alert | DELETE /api/3/sites/{id}/alerts/snmp/{alertId} | Site SNMP Alert |
| SiteApi | delete_site_syslog_alert | DELETE /api/3/sites/{id}/alerts/syslog/{alertId} | Site Syslog Alert |
| SiteApi | enable_shared_credential_on_site | PUT /api/3/sites/{id}/shared_credentials/{credentialId}/enabled | Assigned Shared Credential Enablement |
| SiteApi | enable_site_credential | PUT /api/3/sites/{id}/site_credentials/{credentialId}/enabled | Site Credential Enablement |
| SiteApi | get_excluded_asset_groups | GET /api/3/sites/{id}/excluded_asset_groups | Site Excluded Asset Groups |
| SiteApi | get_excluded_targets | GET /api/3/sites/{id}/excluded_targets | Site Excluded Targets |
| SiteApi | get_included_asset_groups | GET /api/3/sites/{id}/included_asset_groups | Site Included Asset Groups |
| SiteApi | get_included_targets | GET /api/3/sites/{id}/included_targets | Site Included Targets |
| SiteApi | get_site | GET /api/3/sites/{id} | Site |
| SiteApi | get_site_alerts | GET /api/3/sites/{id}/alerts | Site Alerts |
| SiteApi | get_site_assets | GET /api/3/sites/{id}/assets | Site Assets |
| SiteApi | get_site_credential | GET /api/3/sites/{id}/site_credentials/{credentialId} | Site Scan Credential |
| SiteApi | get_site_credentials | GET /api/3/sites/{id}/site_credentials | Site Scan Credentials |
| SiteApi | get_site_discovery_connection | GET /api/3/sites/{id}/discovery_connection | Site Discovery Connection |
| SiteApi | get_site_discovery_search_criteria | GET /api/3/sites/{id}/discovery_search_criteria | Site Discovery Search Criteria |
| SiteApi | get_site_organization | GET /api/3/sites/{id}/organization | Site Organization Information |
| SiteApi | get_site_scan_engine | GET /api/3/sites/{id}/scan_engine | Site Scan Engine |
| SiteApi | get_site_scan_schedule | GET /api/3/sites/{id}/scan_schedules/{scheduleId} | Site Scan Schedule |
| SiteApi | get_site_scan_schedules | GET /api/3/sites/{id}/scan_schedules | Site Scan Schedules |
| SiteApi | get_site_scan_template | GET /api/3/sites/{id}/scan_template | Site Scan Template |
| SiteApi | get_site_shared_credentials | GET /api/3/sites/{id}/shared_credentials | Assigned Shared Credentials |
| SiteApi | get_site_smtp_alert | GET /api/3/sites/{id}/alerts/smtp/{alertId} | Site SMTP Alert |
| SiteApi | get_site_smtp_alerts | GET /api/3/sites/{id}/alerts/smtp | Site SMTP Alerts |
| SiteApi | get_site_snmp_alert | GET /api/3/sites/{id}/alerts/snmp/{alertId} | Site SNMP Alert |
| SiteApi | get_site_snmp_alerts | GET /api/3/sites/{id}/alerts/snmp | Site SNMP Alerts |
| SiteApi | get_site_syslog_alert | GET /api/3/sites/{id}/alerts/syslog/{alertId} | Site Syslog Alert |
| SiteApi | get_site_syslog_alerts | GET /api/3/sites/{id}/alerts/syslog | Site Syslog Alerts |
| SiteApi | get_site_tags | GET /api/3/sites/{id}/tags | Site Tags |
| SiteApi | get_site_users | GET /api/3/sites/{id}/users | Site Users Access |
| SiteApi | get_sites | GET /api/3/sites | Sites |
| SiteApi | get_web_auth_html_forms | GET /api/3/sites/{id}/web_authentication/html_forms | Web Authentication HTML Forms |
| SiteApi | get_web_auth_http_headers | GET /api/3/sites/{id}/web_authentication/http_headers | Web Authentication HTTP Headers |
| SiteApi | remove_all_excluded_asset_groups | DELETE /api/3/sites/{id}/excluded_asset_groups | Site Excluded Asset Groups |
| SiteApi | remove_all_included_asset_groups | DELETE /api/3/sites/{id}/included_asset_groups | Site Included Asset Groups |
| SiteApi | remove_asset_from_site | DELETE /api/3/sites/{id}/assets/{assetId} | Site Asset |
| SiteApi | remove_excluded_asset_group | DELETE /api/3/sites/{id}/excluded_asset_groups/{assetGroupId} | Site Excluded Asset Group |
| SiteApi | remove_included_asset_group | DELETE /api/3/sites/{id}/included_asset_groups/{assetGroupId} | Site Included Asset Group |
| SiteApi | remove_site_assets | DELETE /api/3/sites/{id}/assets | Site Assets |
| SiteApi | remove_site_tag | DELETE /api/3/sites/{id}/tags/{tagId} | Site Tag |
| SiteApi | remove_site_user | DELETE /api/3/sites/{id}/users/{userId} | Site User Access |
| SiteApi | set_site_credentials | PUT /api/3/sites/{id}/site_credentials | Site Scan Credentials |
| SiteApi | set_site_discovery_connection | PUT /api/3/sites/{id}/discovery_connection | Site Discovery Connection |
| SiteApi | set_site_discovery_search_criteria | PUT /api/3/sites/{id}/discovery_search_criteria | Site Discovery Search Criteria |
| SiteApi | set_site_scan_engine | PUT /api/3/sites/{id}/scan_engine | Site Scan Engine |
| SiteApi | set_site_scan_schedules | PUT /api/3/sites/{id}/scan_schedules | Site Scan Schedules |
| SiteApi | set_site_scan_template | PUT /api/3/sites/{id}/scan_template | Site Scan Template |
| SiteApi | set_site_smtp_alerts | PUT /api/3/sites/{id}/alerts/smtp | Site SMTP Alerts |
| SiteApi | set_site_snmp_alerts | PUT /api/3/sites/{id}/alerts/snmp | Site SNMP Alerts |
| SiteApi | set_site_syslog_alerts | PUT /api/3/sites/{id}/alerts/syslog | Site Syslog Alerts |
| SiteApi | set_site_tags | PUT /api/3/sites/{id}/tags | Site Tags |
| SiteApi | set_site_users | PUT /api/3/sites/{id}/users | Site Users Access |
| SiteApi | update_excluded_asset_groups | PUT /api/3/sites/{id}/excluded_asset_groups | Site Excluded Asset Groups |
| SiteApi | update_excluded_targets | PUT /api/3/sites/{id}/excluded_targets | Site Excluded Targets |
| SiteApi | update_included_asset_groups | PUT /api/3/sites/{id}/included_asset_groups | Site Included Asset Groups |
| SiteApi | update_included_targets | PUT /api/3/sites/{id}/included_targets | Site Included Targets |
| SiteApi | update_site | PUT /api/3/sites/{id} | Site |
| SiteApi | update_site_credential | PUT /api/3/sites/{id}/site_credentials/{credentialId} | Site Scan Credential |
| SiteApi | update_site_organization | PUT /api/3/sites/{id}/organization | Site Organization Information |
| SiteApi | update_site_scan_schedule | PUT /api/3/sites/{id}/scan_schedules/{scheduleId} | Site Scan Schedule |
| SiteApi | update_site_smtp_alert | PUT /api/3/sites/{id}/alerts/smtp/{alertId} | Site SMTP Alert |
| SiteApi | update_site_snmp_alert | PUT /api/3/sites/{id}/alerts/snmp/{alertId} | Site SNMP Alert |
| SiteApi | update_site_syslog_alert | PUT /api/3/sites/{id}/alerts/syslog/{alertId} | Site Syslog Alert |
| TagApi | create_tag | POST /api/3/tags | Tags |
| TagApi | delete_tag | DELETE /api/3/tags/{id} | Tag |
| TagApi | get_tag | GET /api/3/tags/{id} | Tag |
| TagApi | get_tag_asset_groups | GET /api/3/tags/{id}/asset_groups | Tag Asset Groups |
| TagApi | get_tag_search_criteria | GET /api/3/tags/{id}/search_criteria | Tag Search Criteria |
| TagApi | get_tagged_assets | GET /api/3/tags/{id}/assets | Tag Assets |
| TagApi | get_tagged_sites | GET /api/3/tags/{id}/sites | Tag Sites |
| TagApi | get_tags | GET /api/3/tags | Tags |
| TagApi | remove_tag_search_criteria | DELETE /api/3/tags/{id}/search_criteria | Tag Search Criteria |
| TagApi | remove_tagged_sites | DELETE /api/3/tags/{id}/sites | Tag Sites |
| TagApi | set_tagged_asset_groups | PUT /api/3/tags/{id}/asset_groups | Tag Asset Groups |
| TagApi | set_tagged_sites | PUT /api/3/tags/{id}/sites | Tag Sites |
| TagApi | tag_asset | PUT /api/3/tags/{id}/assets/{assetId} | Tag Asset |
| TagApi | tag_asset_group | PUT /api/3/tags/{id}/asset_groups/{assetGroupId} | Tag Asset Group |
| TagApi | tag_site | PUT /api/3/tags/{id}/sites/{siteId} | Tag Site |
| TagApi | untag_all_asset_groups | DELETE /api/3/tags/{id}/asset_groups | Tag Asset Groups |
| TagApi | untag_asset | DELETE /api/3/tags/{id}/assets/{assetId} | Tag Asset |
| TagApi | untag_asset_group | DELETE /api/3/tags/{id}/asset_groups/{assetGroupId} | Tag Asset Group |
| TagApi | untag_site | DELETE /api/3/tags/{id}/sites/{siteId} | Tag Site |
| TagApi | update_tag | PUT /api/3/tags/{id} | Tag |
| TagApi | update_tag_search_criteria | PUT /api/3/tags/{id}/search_criteria | Tag Search Criteria |
| UserApi | add_user_asset_group | PUT /api/3/users/{id}/asset_groups/{assetGroupId} | Asset Group Access |
| UserApi | add_user_site | PUT /api/3/users/{id}/sites/{siteId} | Site Access |
| UserApi | create_user | POST /api/3/users | Users |
| UserApi | delete_role | DELETE /api/3/roles/{id} | Role |
| UserApi | get_authentication_source | GET /api/3/authentication_sources/{id} | Authentication Source |
| UserApi | get_authentication_source_users | GET /api/3/authentication_sources/{id}/users | Authentication Source Users |
| UserApi | get_authentication_sources | GET /api/3/authentication_sources | Authentication Sources |
| UserApi | get_privilege | GET /api/3/privileges/{id} | Privilege |
| UserApi | get_privileges | GET /api/3/privileges | Privileges |
| UserApi | get_role | GET /api/3/roles/{id} | Role |
| UserApi | get_role_users | GET /api/3/roles/{id}/users | Users With Role |
| UserApi | get_roles | GET /api/3/roles | Roles |
| UserApi | get_two_factor_authentication_key | GET /api/3/users/{id}/2FA | Two-Factor Authentication |
| UserApi | get_user | GET /api/3/users/{id} | User |
| UserApi | get_user_asset_groups | GET /api/3/users/{id}/asset_groups | Asset Groups Access |
| UserApi | get_user_privileges | GET /api/3/users/{id}/privileges | User Privileges |
| UserApi | get_user_sites | GET /api/3/users/{id}/sites | Sites Access |
| UserApi | get_users | GET /api/3/users | Users |
| UserApi | get_users_with_privilege | GET /api/3/privileges/{id}/users | Users With Privilege |
| UserApi | regenerate_two_factor_authentication | POST /api/3/users/{id}/2FA | Two-Factor Authentication |
| UserApi | remove_all_user_asset_groups | DELETE /api/3/users/{id}/asset_groups | Asset Groups Access |
| UserApi | remove_all_user_sites | DELETE /api/3/users/{id}/sites | Sites Access |
| UserApi | remove_user_asset_group | DELETE /api/3/users/{id}/asset_groups/{assetGroupId} | Asset Group Access |
| UserApi | remove_user_site | DELETE /api/3/users/{id}/sites/{siteId} | Site Access |
| UserApi | reset_password | PUT /api/3/users/{id}/password | Password Reset |
| UserApi | set_two_factor_authentication | PUT /api/3/users/{id}/2FA | Two-Factor Authentication |
| UserApi | set_user_asset_groups | PUT /api/3/users/{id}/asset_groups | Asset Groups Access |
| UserApi | set_user_sites | PUT /api/3/users/{id}/sites | Sites Access |
| UserApi | unlock_user | DELETE /api/3/users/{id}/lock | Unlock Account |
| UserApi | update_role | PUT /api/3/roles/{id} | Role |
| UserApi | update_user | PUT /api/3/users/{id} | User |
| VulnerabilityApi | get_affected_assets | GET /api/3/vulnerabilities/{id}/assets | Vulnerability Affected Assets |
| VulnerabilityApi | get_exploit | GET /api/3/exploits/{id} | Exploit |
| VulnerabilityApi | get_exploit_vulnerabilities | GET /api/3/exploits/{id}/vulnerabilities | Exploitable Vulnerabilities |
| VulnerabilityApi | get_exploits | GET /api/3/exploits | Exploits |
| VulnerabilityApi | get_malware_kit | GET /api/3/malware_kits/{id} | Malware Kit |
| VulnerabilityApi | get_malware_kit_vulnerabilities | GET /api/3/malware_kits/{id}/vulnerabilities | Malware Kit Vulnerabilities |
| VulnerabilityApi | get_malware_kits | GET /api/3/malware_kits | Malware Kits |
| VulnerabilityApi | get_prerequisite_solutions | GET /api/3/solutions/{id}/prerequisites | Solution Prerequisites |
| VulnerabilityApi | get_solution | GET /api/3/solutions/{id} | Solution |
| VulnerabilityApi | get_solutions | GET /api/3/solutions | Solutions |
| VulnerabilityApi | get_superseded_solutions | GET /api/3/solutions/{id}/supersedes | Superseded Solutions |
| VulnerabilityApi | get_superseding_solutions | GET /api/3/solutions/{id}/superseding | Superseding Solutions |
| VulnerabilityApi | get_vulnerabilities | GET /api/3/vulnerabilities | Vulnerabilities |
| VulnerabilityApi | get_vulnerability | GET /api/3/vulnerabilities/{id} | Vulnerability |
| VulnerabilityApi | get_vulnerability_categories | GET /api/3/vulnerability_categories | Categories |
| VulnerabilityApi | get_vulnerability_category | GET /api/3/vulnerability_categories/{id} | Category |
| VulnerabilityApi | get_vulnerability_category_vulnerabilities | GET /api/3/vulnerability_categories/{id}/vulnerabilities | Category Vulnerabilities |
| VulnerabilityApi | get_vulnerability_exploits | GET /api/3/vulnerabilities/{id}/exploits | Vulnerability Exploits |
| VulnerabilityApi | get_vulnerability_malware_kits | GET /api/3/vulnerabilities/{id}/malware_kits | Vulnerability Malware Kits |
| VulnerabilityApi | get_vulnerability_reference | GET /api/3/vulnerability_references/{id} | Reference |
| VulnerabilityApi | get_vulnerability_reference_vulnerabilities | GET /api/3/vulnerability_references/{id}/vulnerabilities | Reference Vulnerabilities |
| VulnerabilityApi | get_vulnerability_references | GET /api/3/vulnerability_references | References |
| VulnerabilityApi | get_vulnerability_references1 | GET /api/3/vulnerabilities/{id}/references | Vulnerability References |
| VulnerabilityApi | get_vulnerability_solutions | GET /api/3/vulnerabilities/{id}/solutions | Vulnerability Solutions |
| VulnerabilityCheckApi | get_vulnerability_check_types | GET /api/3/vulnerability_checks_types | Check Types |
| VulnerabilityCheckApi | get_vulnerability_checks | GET /api/3/vulnerability_checks | Checks |
| VulnerabilityCheckApi | get_vulnerability_checks_for_vulnerability | GET /api/3/vulnerabilities/{id}/checks | Vulnerability Checks |
| VulnerabilityCheckApi | vulnerability_check | GET /api/3/vulnerability_checks/{id} | Check |
| VulnerabilityExceptionApi | create_vulnerability_exception | POST /api/3/vulnerability_exceptions | Exceptions |
| VulnerabilityExceptionApi | get_vulnerability_exception | GET /api/3/vulnerability_exceptions/{id} | Exception |
| VulnerabilityExceptionApi | get_vulnerability_exception_expiration | GET /api/3/vulnerability_exceptions/{id}/expires | Exception Expiration |
| VulnerabilityExceptionApi | get_vulnerability_exceptions | GET /api/3/vulnerability_exceptions | Exceptions |
| VulnerabilityExceptionApi | remove_vulnerability_exception | DELETE /api/3/vulnerability_exceptions/{id} | Exception |
| VulnerabilityExceptionApi | update_vulnerability_exception_expiration | PUT /api/3/vulnerability_exceptions/{id}/expires | Exception Expiration |
| VulnerabilityExceptionApi | update_vulnerability_exception_status | POST /api/3/vulnerability_exceptions/{id}/{status} | Exception Status |
| VulnerabilityResultApi | create_vulnerability_validation | POST /api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations | Asset Vulnerability Validations |
| VulnerabilityResultApi | delete_vulnerability_validation | DELETE /api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations/{validationId} | Asset Vulnerability Validation |
| VulnerabilityResultApi | get_asset_service_vulnerabilities | GET /api/3/assets/{id}/services/{protocol}/{port}/vulnerabilities | Asset Service Vulnerabilities |
| VulnerabilityResultApi | get_asset_vulnerabilities | GET /api/3/assets/{id}/vulnerabilities | Asset Vulnerabilities |
| VulnerabilityResultApi | get_asset_vulnerability | GET /api/3/assets/{id}/vulnerabilities/{vulnerabilityId} | Asset Vulnerability |
| VulnerabilityResultApi | get_vulnerability_validation | GET /api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations/{validationId} | Asset Vulnerability Validation |
| VulnerabilityResultApi | get_vulnerability_validations | GET /api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations | Asset Vulnerability Validations |
- Account
- AdditionalInformation
- Address
- AdhocScan
- AdvisoryLink
- Alert
- AssessmentResult
- Asset
- AssetCreate
- AssetCreatedOrUpdatedReference
- AssetGroup
- AssetHistory
- AssetPolicy
- AssetPolicyAssessment
- AssetPolicyItem
- AssetTag
- AssetVulnerabilities
- AuthenticationSettings
- AuthenticationSource
- AvailableReportFormat
- BackupsSize
- BadRequestError
- Body
- CPUInfo
- Configuration
- ConsoleCommandOutput
- ContentDescription
- CreateAuthenticationSource
- CreatedOrUpdatedReference
- CreatedReference
- CreatedReferenceAssetGroupIDLink
- CreatedReferenceCredentialIDLink
- CreatedReferenceDiscoveryQueryIDLink
- CreatedReferenceEngineIDLink
- CreatedReferencePolicyOverrideIDLink
- CreatedReferenceScanIDLink
- CreatedReferenceScanTemplateIDLink
- CreatedReferenceUserIDLink
- CreatedReferenceVulnerabilityExceptionIDLink
- CreatedReferenceVulnerabilityValidationIDLink
- CreatedReferenceintLink
- Criterion
- Database
- DatabaseConnectionSettings
- DatabaseSettings
- DatabaseSize
- DiscoveryAsset
- DiscoveryConnection
- DiscoverySearchCriteria
- DiskFree
- DiskInfo
- DiskTotal
- DynamicSite
- EnginePool
- EnvironmentProperties
- Error
- ExceptionScope
- ExcludedAssetGroups
- ExcludedScanTargets
- Exploit
- ExploitSource
- ExploitSourceLink
- Features
- File
- Fingerprint
- GlobalScan
- GroupAccount
- HostName
- IMetaData
- IncludedAssetGroups
- IncludedScanTargets
- Info
- InstallSize
- InstallationTotalSize
- InternalServerError
- JVMInfo
- JsonNode
- License
- LicenseLimits
- LicensePolicyScanning
- LicensePolicyScanningBenchmarks
- LicenseReporting
- LicenseScanning
- Link
- Links
- LocalePreferences
- MalwareKit
- MatchedSolution
- MemoryFree
- MemoryInfo
- MemoryTotal
- MetadataContainer
- NotFoundError
- OperatingSystem
- OperatingSystemCpe
- PCI
- PageInfo
- PageOfAsset
- PageOfAssetGroup
- PageOfAssetPolicy
- PageOfAssetPolicyItem
- PageOfDiscoveryConnection
- PageOfExploit
- PageOfGlobalScan
- PageOfMalwareKit
- PageOfOperatingSystem
- PageOfPolicy
- PageOfPolicyAsset
- PageOfPolicyControl
- PageOfPolicyGroup
- PageOfPolicyItem
- PageOfPolicyOverride
- PageOfPolicyRule
- PageOfReport
- PageOfScan
- PageOfSite
- PageOfSoftware
- PageOfTag
- PageOfUser
- PageOfVulnerability
- PageOfVulnerabilityCategory
- PageOfVulnerabilityCheck
- PageOfVulnerabilityException
- PageOfVulnerabilityFinding
- PageOfVulnerabilityReference
- Policy
- PolicyAsset
- PolicyBenchmark
- PolicyControl
- PolicyGroup
- PolicyItem
- PolicyMetadataResource
- PolicyOverride
- PolicyOverrideReviewer
- PolicyOverrideScope
- PolicyOverrideSubmitter
- PolicyRule
- PolicyRuleAssessmentResource
- PolicySummaryResource
- Privileges
- ReferenceWithAlertIDLink
- ReferenceWithAssetIDLink
- ReferenceWithEndpointIDLink
- ReferenceWithEngineIDLink
- ReferenceWithReportIDLink
- ReferenceWithScanScheduleIDLink
- ReferenceWithSiteIDLink
- ReferenceWithTagIDLink
- ReferenceWithUserIDLink
- ReferencesWithAssetGroupIDLink
- ReferencesWithAssetIDLink
- ReferencesWithEngineIDLink
- ReferencesWithReferenceWithEndpointIDLinkServiceLink
- ReferencesWithSiteIDLink
- ReferencesWithSolutionNaturalIDLink
- ReferencesWithTagIDLink
- ReferencesWithUserIDLink
- ReferencesWithVulnerabilityCheckIDLink
- ReferencesWithVulnerabilityCheckTypeIDLink
- ReferencesWithVulnerabilityNaturalIDLink
- ReferencesWithWebApplicationIDLink
- RepeatResource
- RepeatSchedule
- Report
- ReportConfigCategoryFilters
- ReportConfigDatabaseCredentialsResource
- ReportConfigDatabaseResource
- ReportConfigFiltersResource
- ReportConfigScopeResource
- ReportEmail
- ReportEmailSmtp
- ReportFilters
- ReportFrequency
- ReportInstance
- ReportScope
- ReportSize
- ReportStorage
- ReportTemplate
- ResourcesAlert
- ResourcesAssetGroup
- ResourcesAssetTag
- ResourcesAuthenticationSource
- ResourcesAvailableReportFormat
- ResourcesConfiguration
- ResourcesDatabase
- ResourcesDiscoveryAsset
- ResourcesEnginePool
- ResourcesFile
- ResourcesGroupAccount
- ResourcesMatchedSolution
- ResourcesPolicyOverride
- ResourcesReportInstance
- ResourcesReportTemplate
- ResourcesRole
- ResourcesScanEngine
- ResourcesScanSchedule
- ResourcesScanTemplate
- ResourcesSharedCredential
- ResourcesSiteCredential
- ResourcesSiteSharedCredential
- ResourcesSmtpAlert
- ResourcesSnmpAlert
- ResourcesSoftware
- ResourcesSolution
- ResourcesSonarQuery
- ResourcesSyslogAlert
- ResourcesTag
- ResourcesUser
- ResourcesUserAccount
- ResourcesVulnerabilityValidationResource
- ResourcesWebFormAuthentication
- ResourcesWebHeaderAuthentication
- Review
- RiskModifierSettings
- RiskSettings
- Role
- Scan
- ScanEngine
- ScanEvents
- ScanSchedule
- ScanScope
- ScanSettings
- ScanSize
- ScanTargetsResource
- ScanTemplate
- ScanTemplateAssetDiscovery
- ScanTemplateDatabase
- ScanTemplateDiscovery
- ScanTemplateDiscoveryPerformance
- ScanTemplateDiscoveryPerformancePacketsRate
- ScanTemplateDiscoveryPerformanceParallelism
- ScanTemplateDiscoveryPerformanceScanDelay
- ScanTemplateDiscoveryPerformanceTimeout
- ScanTemplateServiceDiscovery
- ScanTemplateServiceDiscoveryTcp
- ScanTemplateServiceDiscoveryUdp
- ScanTemplateVulnerabilityCheckCategories
- ScanTemplateVulnerabilityCheckIndividual
- ScanTemplateVulnerabilityChecks
- ScanTemplateWebSpider
- ScanTemplateWebSpiderPaths
- ScanTemplateWebSpiderPatterns
- ScanTemplateWebSpiderPerformance
- ScheduledScanTargets
- SearchCriteria
- Service
- ServiceLink
- ServiceUnavailableError
- Settings
- SharedCredential
- SharedCredentialAccount
- Site
- SiteCreateResource
- SiteCredential
- SiteDiscoveryConnection
- SiteOrganization
- SiteSharedCredential
- SiteUpdateResource
- SmtpAlert
- SmtpSettings
- SnmpAlert
- Software
- SoftwareCpe
- Solution
- SolutionMatch
- SonarCriteria
- SonarCriterion
- SonarQuery
- StaticSite
- Steps
- Submission
- Summary
- SwaggerDiscoverySearchCriteriaFilter
- SwaggerSearchCriteriaFilter
- SyslogAlert
- Tag
- TagAssetSource
- TagLink
- TaggedAssetReferences
- Telnet
- TokenResource
- UnauthorizedError
- UniqueId
- UpdateId
- UpdateInfo
- UpdateSettings
- User
- UserAccount
- UserCreateRole
- UserRole
- VersionInfo
- Vulnerabilities
- Vulnerability
- VulnerabilityCategory
- VulnerabilityCheck
- VulnerabilityCheckType
- VulnerabilityCvss
- VulnerabilityCvssV2
- VulnerabilityCvssV3
- VulnerabilityEvents
- VulnerabilityException
- VulnerabilityFinding
- VulnerabilityReference
- VulnerabilityValidationResource
- VulnerabilityValidationSource
- WebApplication
- WebFormAuthentication
- WebHeaderAuthentication
- WebPage
- WebSettings
- Type: HTTP basic authentication