4.2. Connection Handler¶
Easy all-in-one connection handler.
-
class
axonius_api_client.connect.
Connect
(url, key, secret, log_console=False, log_file=False, certpath=None, certverify=False, certwarn=True, proxy=None, **kwargs)[source]¶ Bases:
object
Easy all-in-one connection handler for using the API client.
Examples
>>> #!/usr/bin/env python >>> # -*- coding: utf-8 -*- >>> '''Base example for setting up the API client.''' >>> import axonius_api_client as axonapi >>> >>> # get the URL, API key, API secret, & certwarn from the default ".env" file >>> client_args = axonapi.get_env_connect() >>> >>> # OR override OS env vars with the values from a custom .env file >>> # client_args = axonapi.get_env_connect(ax_env="/path/to/envfile", override=True) >>> >>> # create a client using the url, key, and secret from OS env >>> client = axonapi.Connect(**client_args) >>> >>> j = client.jdump # json dump helper >>> >>> client.start() # connect to axonius >>> >>> # client.activity_logs # get audit logs >>> # client.adapters # get adapters and update adapter settings >>> # client.adapters.cnx # CRUD for adapter connections >>> # client.dashboard # get/start/stop discovery cycles >>> # client.devices # get device assets >>> # client.devices.fields # get field schemas for device assets >>> # client.devices.labels # add/remove/get tags for device assets >>> # client.devices.saved_queries # CRUD for saved queries for device assets >>> # client.enforcements # CRUD for enforcements >>> # client.instances # get instances and instance meta data >>> # client.meta # get product meta data >>> # client.remote_support # enable/disable remote support settings >>> # client.settings_global # get/update global system settings >>> # client.settings_gui # get/update gui system settings >>> # client.settings_ip # get/update identity provider system settings >>> # client.settings_lifecycle # get/update lifecycle system settings >>> # client.signup # perform initial signup and use password reset tokens >>> # client.system_roles # CRUD for system roles >>> # client.system_users # CRUD for system users >>> # client.users # get user assets >>> # client.users.fields # get field schemas for user assets >>> # client.users.labels # add/remove/get tags for user assets >>> # client.users.saved_queries # CRUD for saved queries for user assets
- Parameters
url (
str
) –key (
str
) –secret (
str
) –log_console (
bool
) –log_file (
bool
) –certpath (
typing.Union
[str
,pathlib.Path
,None
]) –certverify (
bool
) –certwarn (
bool
) –proxy (
typing.Optional
[str
]) –
-
__init__
(url, key, secret, log_console=False, log_file=False, certpath=None, certverify=False, certwarn=True, proxy=None, **kwargs)[source]¶ Easy all-in-one connection handler.
- Parameters
url (
str
) – URL, hostname, or IP address of Axonius instancekey (
str
) – API Key from account page in Axonius instancesecret (
str
) – API Secret from account page in Axonius instancelog_console (
bool
) – enable logging to consolelog_file (
bool
) – enable logging to filecertpath (
typing.Union
[str
,pathlib.Path
,None
]) – path to CA bundle file to use when verifying certs offered byurl
certverify (
bool
) – raise exception if cert is self-signed or only if cert is invalidcertwarn (
bool
) – show insecure warning once or never show insecure warningproxy (
typing.Optional
[str
]) – proxy to use when making https requests tourl
**kwargs – documented as properties
-
CERT_CLIENT_KEY
: Optional[Union[str, pathlib.Path]]¶ Private key file for cert_client_cert
kwargs=cert_client_key
-
CERT_CLIENT_CERT
: Optional[Union[str, pathlib.Path]]¶ cert file to offer to
url
kwargs=cert_client_cert
-
CERT_CLIENT_BOTH
: Optional[Union[str, pathlib.Path]]¶ cert file with both private key and cert to offer to
url
kwargs=cert_client_both
-
SAVE_HISTORY
: bool¶ append responses to
axonius_api_client.http.Http.HISTORY
kwargs=save_history
-
LOG_REQUEST_ATTRS
: Optional[List[str]]¶ request attrs to log
axonius_api_client.constants.logs.REQUEST_ATTR_MAP
kwargs=log_request_attrs
-
LOG_RESPONSE_ATTRS
: Optional[List[str]]¶ response attrs to log
axonius_api_client.constants.logs.RESPONSE_ATTR_MAP
kwargs=log_response_attrs
-
LOG_LOGGER
: logging.Logger¶ logger to use as package root logger
kwargs=log_logger
-
LOG_LEVEL_HTTP
: Union[str, int]¶ log level for
axonius_api_client.http.Http
kwargs=log_level_http
-
LOG_LEVEL_AUTH
: Union[str, int]¶ log level for
axonius_api_client.auth.models.Mixins
kwargs=log_level_auth
-
LOG_LEVEL_API
: Union[str, int]¶ log level for
axonius_api_client.api.mixins.ModelMixins
kwargs=log_level_api
-
LOG_FILE_NAME
: Union[str, pathlib.Path]¶ name of file to write logs to under
LOG_FILE_PATH
kwargs=log_file_name
-
LOG_FILE_PATH
: Union[str, pathlib.Path]¶ path to write
LOG_FILE_NAME
tokwargs=log_file_path
-
LOG
: logging.Logger¶ logger object to use
-
HANDLER_CON
: logging.StreamHandler¶ console logging handler
-
HANDLER_FILE
: logging.handlers.RotatingFileHandler¶ file logging handler
-
HTTP
¶ axonius_api_client.http.Http
client to use forAUTH
-
AUTH
¶ axonius_api_client.auth.api_key.ApiKey
auth method to use for all API models
-
SIGNUP
¶ Easy access to signup.
-
property
signup
¶ Work with signup endpoints.
- Return type
-
property
users
¶ Work with user assets.
- Return type
-
property
devices
¶ Work with device assets.
- Return type
-
property
adapters
¶ Work with adapters and adapter connections.
-
property
instances
¶ Work with instances.
-
property
activity_logs
¶ Work with activity logs.
- Return type
axonius_api_client.api.system.activity_logs.ActivityLogs
-
property
remote_support
¶ Work with configuring remote support.
- Return type
axonius_api_client.api.system.remote_support.RemoteSupport
-
property
dashboard
¶ Work with dashboards and discovery cycles.
-
property
enforcements
¶ Work with Enforcement Center.
-
property
system_users
¶ Work with system users.
-
property
system_roles
¶ Work with system roles.
-
property
meta
¶ Work with instance metadata.
- Return type
-
property
settings_ip
¶ Work with identity providers settings.
- Return type
axonius_api_client.api.system.settings_identity_providers.SettingsIdentityProviders
-
property
settings_global
¶ Work with core system settings.
-
property
settings_gui
¶ Work with gui system settings.
-
property
settings_lifecycle
¶ Work with lifecycle system settings.
-
classmethod
_get_exc_reason
(exc)[source]¶ Trim exceptions down to a more user friendly display.
Uses
REASON_RES
to do regex substituions.