4.6. System

Warning

This API is deprecated.

Axonius API v2 is now available, we recommend you move to API v2.

New features will no longer be added to this API. Axonius will only provide bug fixes.

Read about API v2

• 4.6.1. Dashboards and discovery cycles
  • DiscoverPhase
    • DiscoverPhase.raw
    • DiscoverPhase.to_str_properties()
    • DiscoverPhase.to_str_progress()
    • DiscoverPhase.name
    • DiscoverPhase.human_name
    • DiscoverPhase.is_done
    • DiscoverPhase.progress
    • DiscoverPhase.name_map
    • DiscoverPhase.__init__()
    • DiscoverPhase.__str__()
    • DiscoverPhase._human_key()
    • DiscoverPhase.get_fields()
    • DiscoverPhase.replace()
    • DiscoverPhase.to_dict()
  • DiscoverData
    • DiscoverData.raw
    • DiscoverData.adapters
    • DiscoverData.to_str_progress()
    • DiscoverData.to_str_phases()
    • DiscoverData.phases_dict
    • DiscoverData.to_dict()
    • DiscoverData.last_run_finish_date
    • DiscoverData.last_run_start_date
    • DiscoverData.current_run_duration_in_minutes
    • DiscoverData.last_run_duration_in_minutes
    • DiscoverData.last_run_minutes_ago
    • DiscoverData.next_run_starts_in_minutes
    • DiscoverData.next_run_start_date
    • DiscoverData.correlation_stage
    • DiscoverData.correlation_phase
    • DiscoverData.is_correlation_finished
    • DiscoverData.running_status_map
    • DiscoverData.is_running
    • DiscoverData.status
    • DiscoverData.progress
    • DiscoverData.phases
    • DiscoverData.next_run_within_minutes()
    • DiscoverData.get_stability()
    • DiscoverData.__init__()
    • DiscoverData.__str__()
    • DiscoverData._human_key()
    • DiscoverData.get_fields()
    • DiscoverData.replace()
    • DiscoverData.to_str_properties()
  • Dashboard
    • Dashboard.get()
    • Dashboard.is_running
    • Dashboard.start()
    • Dashboard.stop()
    • Dashboard._get()
    • Dashboard._start()
    • Dashboard._stop()
    • Dashboard._init()
    • Dashboard.LOG
    • Dashboard.__init__()
    • Dashboard.__repr__()
    • Dashboard.__str__()
    • Dashboard._init_auth()
    • Dashboard.auth
    • Dashboard.http
• 4.6.2. Instances
  • Instances
    • Instances.get()
    • Instances.get_core()
    • Instances.get_collectors()
    • Instances.get_by_name()
    • Instances.get_by_name_id_core()
    • Instances.check_tunnel_feature()
    • Instances.get_tunnels()
    • Instances.get_tunnel()
    • Instances.get_tunnel_default()
    • Instances.set_name()
    • Instances.get_hostname()
    • Instances.set_hostname()
    • Instances.get_is_env_name()
    • Instances.set_is_env_name()
    • Instances.get_central_core_mode()
    • Instances.set_central_core_mode()
    • Instances.get_core_delete_mode()
    • Instances.set_core_delete_mode()
    • Instances.factory_reset()
    • Instances.get_central_core_config()
    • Instances.restore_from_aws_s3()
    • Instances.api_version
    • Instances.api_versions
    • Instances.feature_flags
    • Instances.has_saas_enabled
    • Instances.has_cloud_compliance
    • Instances.trial_expiry
    • Instances.trial_days_left
    • Instances.license_expiry
    • Instances.license_days_left
    • Instances.admin_script_upload()
    • Instances.admin_script_upload_path()
    • Instances._get()
    • Instances._factory_reset()
    • Instances._delete()
    • Instances._update_attrs()
    • Instances._update_active()
    • Instances._get_central_core_config()
    • Instances._update_central_core_config()
    • Instances._restore_aws()
    • Instances._feature_flags()
    • Instances._admin_script_upload()
    • Instances._admin_script_execute()
    • Instances._get_api_version()
    • Instances.LOG
    • Instances.__init__()
    • Instances.__repr__()
    • Instances.__str__()
    • Instances._init()
    • Instances._init_auth()
    • Instances.auth
    • Instances.http
• 4.6.3. Product metadata
  • Meta
    • Meta.ABOUT_DATA1
    • Meta.ABOUT_DATA2
    • Meta.about()
    • Meta.historical_sizes()
    • Meta.version
    • Meta._about()
    • Meta._about2()
    • Meta._historical_sizes()
    • Meta._get_constants()
    • Meta.LOG
    • Meta.__init__()
    • Meta.__repr__()
    • Meta.__str__()
    • Meta._init()
    • Meta._init_auth()
    • Meta.auth
    • Meta.http
• 4.6.4. System Settings -> Global Settings
• 4.6.5. System Settings -> GUI Settings
• 4.6.6. System Settings -> Lifecycle Settings
• 4.6.7. Initial signup
  • Signup
    • Signup.is_signed_up
    • Signup.system_status
    • Signup.signup()
    • Signup.validate_password_reset_token()
    • Signup.use_password_reset_token()
    • Signup.is_expired
    • Signup.is_licensed
    • Signup.indication_color
    • Signup.login_options
    • Signup._get_login_options()
    • Signup._get_indication_color()
    • Signup._license_status()
    • Signup._expired()
    • Signup._status()
    • Signup._get()
    • Signup._token_validate()
    • Signup._token_use()
    • Signup._perform()
    • Signup.LOG
    • Signup.__init__()
    • Signup.__repr__()
    • Signup.__str__()
    • Signup._init()
    • Signup._init_auth()
    • Signup.auth
    • Signup.http
• 4.6.8. System Roles
  • SystemRoles
    • SystemRoles._parse_cat_actions()
    • SystemRoles.get()
    • SystemRoles.get_generator()
    • SystemRoles.get_cached()
    • SystemRoles.get_cached_single()
    • SystemRoles.get_by_name()
    • SystemRoles.get_by_uuid()
    • SystemRoles.add()
    • SystemRoles.check_exists()
    • SystemRoles.update_data_scope()
    • SystemRoles.set_name()
    • SystemRoles.set_perms()
    • SystemRoles.delete_by_name()
    • SystemRoles.pretty_perms()
    • SystemRoles._get()
    • SystemRoles._add()
    • SystemRoles._update()
    • SystemRoles._delete()
    • SystemRoles._get_labels()
    • SystemRoles.cat_actions
    • SystemRoles._check_predefined()
    • SystemRoles.cat_actions_to_perms()
    • SystemRoles._init()
    • SystemRoles.data_scopes
    • SystemRoles.LOG
    • SystemRoles.__init__()
    • SystemRoles.__repr__()
    • SystemRoles.__str__()
    • SystemRoles._init_auth()
    • SystemRoles.auth
    • SystemRoles.http
• 4.6.9. System Users
  • SystemUsers
    • SystemUsers.get()
    • SystemUsers.get_generator()
    • SystemUsers.get_cached_single()
    • SystemUsers.get_cached()
    • SystemUsers.get_by_name()
    • SystemUsers.get_by_uuid()
    • SystemUsers.add()
    • SystemUsers.set_role()
    • SystemUsers.set_first_last()
    • SystemUsers.set_password()
    • SystemUsers.set_email()
    • SystemUsers.set_ignore_role_assignment_rules()
    • SystemUsers.delete_by_name()
    • SystemUsers.get_password_reset_link()
    • SystemUsers.email_password_reset_link()
    • SystemUsers._get()
    • SystemUsers._add()
    • SystemUsers._delete()
    • SystemUsers._update()
    • SystemUsers._tokens_generate()
    • SystemUsers._tokens_notify()
    • SystemUsers._init()
    • SystemUsers._update_user_attr()
    • SystemUsers.LOG
    • SystemUsers.__init__()
    • SystemUsers.__repr__()
    • SystemUsers.__str__()
    • SystemUsers._init_auth()
    • SystemUsers.auth
    • SystemUsers.http