4.6.3. Product metadata¶

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

API for working with product metadata.

class axonius_api_client.api.system.meta.Meta(auth, log_level='debug', **kwargs)[source]¶

Bases: ModelMixins

API for working with product metadata.

Examples

Get the about page: about()
Get the product version: version()
Get historical data disk usage stats: historical_sizes()

Parameters:

auth (axonius_api_client.auth.model.AuthModel) –
log_level (typing.Union[int, str]) –

ABOUT_DATA1: typing.Optional[dict] = None¶

ABOUT_DATA2: typing.Optional[dict] = None¶

about(error=True)[source]¶

Get about page metadata.

Examples

Create a client using axonius_api_client.connect.Connect

>>> data = client.meta.about()
>>> j(data)
{
  "Build Date": "Fri Oct 2 00:18:27 UTC 2020",
  "Customer ID": "e1d48d82f50a4d2085658fea1a59b979",
  "api_client_version": "4.0",
  "Version": "3.10"
}

Parameters:: error (bool) –
Return type:: dict

historical_sizes()[source]¶

Get disk usage metadata. :rtype: dict

Examples

Create a client using axonius_api_client.connect.Connect

>>> data = client.meta.historical_sizes()
>>> data['disk_free_mb']
70.93
>>> data['disk_used_mb']
122.87
>>> list(data)
['disk_free_mb', 'disk_used_mb', 'historical_sizes_devices', 'historical_sizes_users']

property version: str¶

Get the version of Axonius.

Examples

Create a client using axonius_api_client.connect.Connect

>>> client.meta.version
'3.10'

_about()[source]¶

Direct API method to get the About page.

Return type:: dict

_about2()[source]¶

Direct API method to get the About page.

Return type:: dict

_historical_sizes()[source]¶

Direct API method to get the metadata about disk usage.

Return type:: dict

_get_constants()[source]¶

Direct API method to get constants.

Return type:: dict

LOG: logging.Logger = None¶: Logger for this object.

__init__(auth, log_level='debug', **kwargs)¶

Mixins for API Models.

Parameters:

auth (axonius_api_client.auth.model.AuthModel) – object to use for auth and sending API requests
log_level (typing.Union[int, str]) – logging level to use for this objects logger
**kwargs – passed to _init()

__repr__()¶

Show info for this model object.

Return type:: str

__str__()¶

Show info for this model object.

Return type:: str

_init(**kwargs)¶: Post init method for subclasses to use for extra setup.

_init_auth(**kwargs)¶: Post init method for subclasses to use for overriding auth setup.

auth: AuthModel = None¶: Authentication model with bound Http object to use for requests.

http: Http = None¶: Http object to use for requests.