4.7. Library backend¶
- 4.7.1. API library backend
- 4.7.1.1. API models
- 4.7.1.2. Asset API models
AssetMixinAssetMixin.ASSET_TYPEAssetMixin.asset_types()AssetMixin.asset_modules()AssetMixin.run_enforcement()AssetMixin.run_enforcement_from_items()AssetMixin.run_enforcement_from_json()AssetMixin.run_enforcement_from_jsonl()AssetMixin.run_enforcement_from_csv()AssetMixin.run_enforcement_from_text()AssetMixin.run_enforcement_from_json_path()AssetMixin.run_enforcement_from_jsonl_path()AssetMixin.run_enforcement_from_csv_path()AssetMixin.run_enforcement_from_text_path()AssetMixin.enforcementsAssetMixin.count()AssetMixin.count_by_saved_query()AssetMixin.get()AssetMixin.get_generator()AssetMixin.get_by_saved_query()AssetMixin.get_wiz_entries()AssetMixin.get_sort_field()AssetMixin.get_history_date()AssetMixin.get_by_id()AssetMixin.fields_defaultAssetMixin.destroy()AssetMixin.get_by_values()AssetMixin.get_by_value_regex()AssetMixin.get_by_value()AssetMixin.history_dates_obj()AssetMixin.history_dates()AssetMixin._build_query()AssetMixin.build_get_request()AssetMixin.build_count_request()AssetMixin.data_scopesAssetMixin._init()AssetMixin._get()AssetMixin._count()AssetMixin._get_by_id()AssetMixin._destroy()AssetMixin._history_dates()AssetMixin._run_enforcement()AssetMixin.FIELD_TAGSAssetMixin.FIELD_AXON_IDAssetMixin.FIELD_ADAPTERSAssetMixin.FIELD_ADAPTER_LENAssetMixin.FIELD_LAST_SEENAssetMixin.FIELD_MAINAssetMixin.FIELD_SIMPLEAssetMixin.LOGAssetMixin.__init__()AssetMixin.__repr__()AssetMixin.__str__()AssetMixin._init_auth()AssetMixin.authAssetMixin.httpAssetMixin.FIELD_COMPLEXAssetMixin.FIELD_COMPLEX_SUBAssetMixin.FIELDS_APIAssetMixin.wizardAssetMixin.wizard_textAssetMixin.wizard_csv
- 4.7.1.3. Endpoint routers
- 4.7.1.4. Settings mixins
- 4.7.2. Authenticating
- 4.7.2.1. Authenticating
AuthApiKeyAuthApiKey.__init__()AuthApiKey.login()AuthApiKey.fieldsAuthApiKey.logout()AuthApiKey.CLIENTAuthApiKey.LOGAuthApiKey.LOGIN_RESPONSEAuthApiKey.VALIDATE_RESPONSEAuthApiKey.__repr__()AuthApiKey.__str__()AuthApiKey._get_api_keys()AuthApiKey._get_current_user()AuthApiKey.check_login()AuthApiKey.get_api_keys()AuthApiKey.get_current_user()AuthApiKey.httpAuthApiKey.is_logged_inAuthApiKey.urlAuthApiKey.validate()
- 4.7.2.2. Models
- 4.7.2.1. Authenticating
- 4.7.3. Constants
- 4.7.3.1. Adapters
- 4.7.3.2. API models
SETTING_UNCHANGEDFIELD_TRIM_LENFIELD_TRIM_STRFIELD_JOINERTABLE_FORMATTABLE_MAX_ROWSMAX_PAGE_SIZEPAGE_SIZEPAGE_SLEEPGUI_PAGE_SIZESTIMEOUT_CONNECTTIMEOUT_RESPONSEDEFAULT_CALLBACKS_CLSCOUNT_POLLING_ATTEMPTSCOUNT_POLLING_SLEEPAS_DATACLASSFolderDefaultsFolderDefaults.all_objectsFolderDefaults.confirmFolderDefaults.delete_subfoldersFolderDefaults.delete_objectsFolderDefaults.createFolderDefaults.create_actionFolderDefaults.echoFolderDefaults.echo_actionFolderDefaults.error_no_matchesFolderDefaults.error_no_objectsFolderDefaults.error_unmatchedFolderDefaults.full_objectsFolderDefaults.full_objects_searchFolderDefaults.ignore_caseFolderDefaults.include_detailsFolderDefaults.include_objectsFolderDefaults.include_subfoldersFolderDefaults.copy_prefixFolderDefaults.pattern_prefixFolderDefaults.promptFolderDefaults.prompt_defaultFolderDefaults.prompt_shellFolderDefaults.query_typeFolderDefaults.recursiveFolderDefaults.refreshFolderDefaults.refresh_actionFolderDefaults.sep
- 4.7.3.3. Fields
AGG_ADAPTER_NAMEAGG_ADAPTER_TITLEAXIDALL_NAMEAGG_EXPR_FIELD_TYPEAGG_ADAPTER_ALTSGET_SCHEMAS_KEYSGET_SCHEMA_KEYSFUZZY_SCHEMAS_KEYSPRETTY_SCHEMA_TMPLFIELDS_DETAILSFIELDS_DETAILS_EXCLUDEFIELDS_ENTITY_PASSTHRUSCHEMAS_CUSTOMParsersParsers.to_csv_adaptersParsers.to_csv_cnx_labelParsers.to_csv_intParsers.to_csv_ipParsers.to_csv_strParsers.to_csv_subnetParsers.to_csv_tagsParsers.to_csv_tags_expirableParsers.to_dtParsers.to_in_subnetParsers.to_intParsers.to_ipParsers.to_noneParsers.to_raw_versionParsers.to_strParsers.to_str_adaptersParsers.to_str_cnx_labelParsers.to_str_escaped_regexParsers.to_str_subnetParsers.to_str_tagsParsers.to_str_tags_expirableParsers.to_str_sqParsers.to_str_data_scope
TypesFormatsOperatorNameMapOperatorNameMapsOperatorNameMaps.containsOperatorNameMaps.count_equalsOperatorNameMaps.count_less_thanOperatorNameMaps.count_more_thanOperatorNameMaps.endswithOperatorNameMaps.equalsOperatorNameMaps.equals_emptyOperatorNameMaps.existsOperatorNameMaps.is_falseOperatorNameMaps.is_trueOperatorNameMaps.is_inOperatorNameMaps.is_in_subnetOperatorNameMaps.is_ipv4OperatorNameMaps.is_ipv6OperatorNameMaps.is_not_in_subnetOperatorNameMaps.last_daysOperatorNameMaps.last_hoursOperatorNameMaps.less_thanOperatorNameMaps.more_thanOperatorNameMaps.next_daysOperatorNameMaps.next_hoursOperatorNameMaps.regexOperatorNameMaps.startswithOperatorNameMaps.earlier_thanOperatorNameMaps.later_thanOperatorNameMaps.__init__()OperatorNameMaps._human_key()OperatorNameMaps.get_fields()OperatorNameMaps.replace()OperatorNameMaps.to_dict()
Operatorops_clean()OperatorsOperators.containsOperators.count_equalsOperators.count_less_thanOperators.count_more_thanOperators.endswithOperators.equals_strOperators.equals_str_tagOperators.equals_str_tag_expirableOperators.equals_str_adapterOperators.equals_str_cnx_labelOperators.equals_str_sqOperators.equals_str_data_scopeOperators.equals_ipOperators.equals_subnetOperators.equals_intOperators.existsOperators.exists_arrayOperators.exists_array_objectOperators.ip_in_subnetOperators.ip_not_in_subnetOperators.ipv4Operators.ipv6Operators.is_in_strOperators.is_in_str_tagOperators.is_in_str_tag_expirableOperators.is_in_str_adapterOperators.is_in_str_cnx_labelOperators.is_in_intOperators.is_in_ipOperators.is_in_subnetOperators.is_falseOperators.is_trueOperators.last_hoursOperators.last_daysOperators.less_than_dateOperators.less_than_intOperators.earlier_than_versionOperators.more_than_dateOperators.more_than_intOperators.later_than_versionOperators.next_hoursOperators.next_daysOperators.regexOperators.startswithOperators.__init__()Operators._human_key()Operators.get_fields()Operators.replace()Operators.to_dict()
OperatorTypeMapOperatorTypeMapsOperatorTypeMaps.string_sqOperatorTypeMaps.string_data_scopeOperatorTypeMaps.string_cnx_labelOperatorTypeMaps.stringOperatorTypeMaps.string_os_distributionOperatorTypeMaps.string_tag_expirableOperatorTypeMaps.string_tagOperatorTypeMaps.string_ipOperatorTypeMaps.string_datetimeOperatorTypeMaps.string_dateOperatorTypeMaps.string_imageOperatorTypeMaps.__init__()OperatorTypeMaps._human_key()OperatorTypeMaps.get_fields()OperatorTypeMaps.replace()OperatorTypeMaps.to_dict()OperatorTypeMaps.string_versionOperatorTypeMaps.string_subnetOperatorTypeMaps.booleanOperatorTypeMaps.integerOperatorTypeMaps.numberOperatorTypeMaps.array_objectOperatorTypeMaps.array_table_objectOperatorTypeMaps.array_integerOperatorTypeMaps.array_numberOperatorTypeMaps.array_stringOperatorTypeMaps.array_string_tagOperatorTypeMaps.array_string_versionOperatorTypeMaps.array_string_datetimeOperatorTypeMaps.array_string_subnetOperatorTypeMaps.array_discrete_string_logoOperatorTypeMaps.array_string_ipOperatorTypeMaps.array_string_ip_preferredOperatorTypeMaps.get_type_map()OperatorTypeMaps.get_operator()
CUSTOM_FIELDS_MAP
- 4.7.3.4. General
- 4.7.3.5. Logs
LOG_FMT_VERBOSELOG_FMT_BRIEF_SRCLOG_FMT_BRIEFLOG_FMT_CONSOLELOG_FMT_FILELOG_DATEFMT_CONSOLELOG_DATEFMT_FILELOG_LEVEL_CONSOLELOG_LEVEL_FILELOG_LEVEL_HTTPLOG_LEVEL_AUTHLOG_LEVEL_APILOG_LEVEL_WIZARDLOG_LEVEL_PACKAGELOG_LEVELS_STRLOG_LEVELS_STR_CSVLOG_LEVELS_INTLOG_LEVELS_INT_CSVLOG_FILE_PATHLOG_FILE_PATH_MODELOG_FILE_NAMELOG_FILE_MAX_MBLOG_FILE_MAX_FILESLOG_NAME_STDERRLOG_NAME_STDOUTLOG_NAME_FILEMAX_BODY_LENRESPONSE_ATTR_MAPREQUEST_ATTR_MAPRESPONSE_ATTRSREQUEST_ATTRSRESPONSE_ATTRS_DEFAULTREQUEST_ATTRS_DEFAULT
- 4.7.3.6. System
- 4.7.3.7. Wizards
TemplatesResultsPatternsFlagsEntryEntrySqTypesDocsSourcesFieldsExprExpr.BRACKET_LEFTExpr.BRACKET_RIGHTExpr.BRACKET_WEIGHTExpr.CHILDRENExpr.CONDITIONExpr.CONTEXTExpr.EXPRExpr.FIELDExpr.FIELD_TYPEExpr.FILTERExpr.FILTER_ADAPTERSExpr.IDXExpr.NOTExpr.OP_COMPExpr.OP_LOGICExpr.VALUEExpr.CONTEXT_OBJExpr.OP_ANDExpr.OP_ORExpr.OP_IDX0Expr.get_query()Expr.get_subs_query()Expr.build()Expr.build_child()
- 4.7.4. Parsers
- 4.7.4.1. Adapter schemas
- 4.7.4.2. Configuration schemas
config_check()config_check_file()config_check_bool()config_check_int()config_check_array()parse_unchanged()config_check_str()config_build()config_unknown()config_unchanged()config_default()config_required()config_empty()config_info()is_uploaded_file()parse_schema()parse_schema_enum()parse_section()parse_settings()
- 4.7.4.3. Field schemas
- 4.7.4.4. System
- 4.7.4.5. Tables
- 4.7.4.6. URLs
- 4.7.4.7. Wizards
WizardParserWizardParser.__init__()WizardParser.apiobjWizardParser.__call__()WizardParser.value_to_csv_adapters()WizardParser.value_to_csv_cnx_label()WizardParser.value_to_csv_int()WizardParser.value_to_csv_ip()WizardParser.value_to_csv_str()WizardParser.value_to_csv_subnet()WizardParser.value_to_csv_tags()WizardParser.value_to_csv_tags_expirable()WizardParser.value_to_dt()WizardParser.value_to_in_subnet()WizardParser.value_to_int()WizardParser.value_to_ip()WizardParser.value_to_none()WizardParser.value_to_raw_version()WizardParser.value_to_str()WizardParser.value_to_str_adapters()WizardParser.value_to_str_sq()WizardParser.value_to_str_data_scope()WizardParser.value_to_str_cnx_label()WizardParser.value_to_str_escaped_regex()WizardParser.value_to_str_tags()WizardParser.value_to_str_tags_expirable()WizardParser.value_to_str_subnet()WizardParser.parse_csv()WizardParser.check_enum()WizardParser.enum_cb_sq()WizardParser.enum_cb_cnx_label()WizardParser.enum_cb_asset_tags()WizardParser.enum_cb_asset_tags_expirable()WizardParser.enum_cb_adapter_name()WizardParser.enum_cb_data_scope()WizardParser.get_adapters()WizardParser.get_cnx_labels()WizardParser.get_instances()WizardParser.get_sqs()WizardParser.get_asset_tags()WizardParser.get_asset_tags_expirable()
- 4.7.5. Tools
- 4.7.5.1. Data classes
- 4.7.5.2. Exceptions and warnings
get_exc_str()AxonWarningApiWarningGuiQueryWizardWarningExtraAttributeWarningUnknownFieldSchemaAxonErrorAxonTypeErrorApiErrorConfirmNotTrueNotAllowedErrorToolsErrorAuthErrorNotFoundErrorSavedQueryNotFoundErrorSavedQueryTagsNotFoundErrorAlreadyExistsNotLoggedInAlreadyLoggedInConnectErrorHttpErrorConfigErrorConfigInvalidValueConfigUnchangedConfigUnknownConfigRequiredCnxErrorCnxGoneErrorCnxUpdateErrorCnxTestErrorCnxAddErrorResponseErrorInvalidCredentialsResponseNotOkJsonInvalidErrorJsonErrorWizardErrorApiAttributeExtraWarningApiAttributeErrorApiAttributeTypeErrorApiAttributeMissingErrorNoTriggerDefinedErrorStopFetchSchemaErrorRequestErrorRequestMissingArgsErrorRequestObjectTypeErrorRequestFormatErrorRequestFormatPathErrorRequestFormatObjectErrorRequestLoadObjectErrorResponseLoadObjectErrorFeatureNotEnabledErrorRunnerErrorRunnerWarningGrabberErrorGrabberWarningFolderAlreadyExistsErrorFolderNotFoundErrorSearchErrorSearchUnmatchedErrorSearchNoMatchesErrorSearchNoObjectsErrorDecodeErrorInvalidObjectIdErrorInvalidTypeErrorFormatError
- 4.7.5.3. HTTP Client
is_headers()is_cookies()HttpHttp.LOG_REQUEST_ATTRSHttp.LOG_RESPONSE_ATTRSHttp.URL_CERTHttp.URL_CERT_CHAINHttp.CLIENTHttp.__init__()Http.sessionHttp.LOG_LEVELHttp.LOGHttp.HISTORYHttp.LAST_REQUESTHttp.LAST_RESPONSEHttp.LOG_BODY_LINESHttp.LOG_HIDE_HEADERSHttp.LOG_HIDE_STRHttp.LOG_LEVEL_URLLIBHttp.LOG_REQUEST_BODYHttp.LOG_RESPONSE_BODYHttp.URLPARSEDHttp.urlHttp.HTTP_HEADERSHttp.HTTP_COOKIESHttp.CERT_PATHHttp.CERT_WARNHttp.CERT_VERIFYHttp.CERT_CLIENT_BOTHHttp.CERT_CLIENT_CERTHttp.CERT_CLIENT_KEYHttp.CONNECT_TIMEOUTHttp.RESPONSE_TIMEOUTHttp.HTTP_PROXYHttp.HTTPS_PROXYHttp.SAVE_HISTORYHttp.SAVE_LASTHttp.MAX_RETRIESHttp.RETRY_BACKOFFHttp.set_cf_token()Http.safe_request()Http.get_cert()Http.get_cert_chain()Http.parse_url()Http.new_session()Http.set_session_headers()Http.set_session_cookies()Http.set_session_proxies()Http.set_session_verify()Http.set_session_cert()Http.set_urllib_warnings()Http.set_urllib_log()Http.__call__()Http.__str__()Http.__repr__()Http.user_agentHttp._do_log_request()Http._clean_headers()Http._do_log_response()Http.log_request_attrsHttp.log_response_attrsHttp._get_log_attrs()Http._set_log_attrs()Http.log_body()Http._init()
- 4.7.5.4. Logging utilities
HideFormatterHideFormatter.HIDE_ENABLEDHideFormatter.HIDE_REGEXHideFormatter.HIDE_REPLACEHideFormatter.format()HideFormatter.__init__()HideFormatter.converter()HideFormatter.default_msec_formatHideFormatter.default_time_formatHideFormatter.formatException()HideFormatter.formatMessage()HideFormatter.formatStack()HideFormatter.formatTime()HideFormatter.usesTime()
get_echoer()get_log_method()gmtime()localtime()get_obj_log()set_log_level()str_level()add_stderr()add_stdout()add_file()add_null()add_handler()del_stderr()del_stdout()del_file()del_null()del_handler()find_handlers()handle_unhandled_exception()
- 4.7.5.5. Setup environment variables
LOGGERYESNOCF_PREKEY_DEFAULT_PATHKEY_ENV_FILEKEY_ENV_PATHKEY_OVERRIDEKEY_URLKEY_KEYKEY_SECRETKEY_FEATURESKEY_CERTWARNKEY_CERTPATHKEY_DEBUGKEY_DEBUG_PRINTKEY_USER_AGENTDEFAULT_DEBUGDEFAULT_DEBUG_PRINTDEFAULT_OVERRIDEDEFAULT_CERTWARNDEFAULT_ENV_FILEKEYS_HIDDENKEY_MATCHESHIDDENis_empty_object()is_empty_string()is_empty()Resultsspew()get_file_or_dir_with_file()find_dotenv()MSGload_dotenv()get_env_ax_env()get_env_str()get_env_bool()get_env_extra_warn()get_env_path()get_env_csv()get_env_user_agent()load_schema()get_env_connect()get_env_features()hide_value()hide_values()get_env_ax()set_env()bytes_to_str()DEBUG_PRINTDEBUGDEFAULT_PATH
- 4.7.5.6. Utilities
type_str()pathify()is_existing_file()listify()grouper()coerce_int()coerce_int_float()coerce_bool()is_str()is_email()is_int()join_url()strip_right()strip_left()AxJSONEncoderhas_to_dict()json_dump()lens()tlens()json_load()is_file_like()csv_load()jsonl_loader()jsonl_load()json_log()json_reload()text_load()dt_parse_uuid()dt_parse()dt_parse_tmpl()dt_now()dt_now_file()dt_sec_ago()dt_days_ago()dt_min_ago()dt_days_left()dt_within_min()get_path()path_read()get_backup_filename()get_backup_path()check_path_is_not_dir()path_create_parent_dir()path_backup_file()auto_suffix()path_write()longest_str()split_str()echo_debug()echo_ok()echo_warn()echo_error()echo()sysinfo()calc_percent()trim_float()join_kv()get_type_str()check_type()check_empty()get_raw_version()coerce_str_to_csv()parse_ip_address()parse_ip_network()kv_dump()bom_strip()read_stream()check_gui_page_size()calc_gb()calc_perc_gb()get_subcls()prettify_obj()token_parse()combo_dicts()is_url()bytes_to_str()strip_str()coerce_str()str_trim()get_cls_path()csv_writer()parse_int_min_max()safe_replace()safe_format()get_paths_format()int_days_map()lowish()log_or_exc()coerce_io()is_json_dict()extract_kvs_auto()trype()extract_kvs_json()is_callable()extract_kvs_csv()tilde_re()coerce_str_re()human_size()is_pattern()is_tty()check_tty()check_tty_stdin()get_secho_args()confirm()coerce_prompt_confirm()check_confirm_prompt()csv_able()is_list()style_switch()add_source()parse_value_copy()parse_refresh()get_diff_seconds()score_prefix()get_mm_field()get_mm_description()is_nested_schema()get_nested_schema()get_hint_type()is_subclass()get_query_id()jdump()is_subclass_safe()trim_value_repr()coerce_seconds()coerce_delta()coerce_date_delta()
- 4.7.6. Version metadata