Axonius-api-client

AXONSHELL

AXONSHELL fixes

- axonshell devices get*: remove 'base' from export_format
- axonshell adapters cnx *: was not prompting due to issue with fetching schemas
- axonshell *: many fixes to commands that were not tested previously

AXONSHELL enhancments

- open-api get-spec: add gen version/date to OAS output file
- axonshell devices saved-query *: add more metadata to --export-format str
- axonshell devices saved-query *: add table as --export-format
- adapters cnx *: reworked from the ground up, prompting with more verbose output, better validation, and more...
- NEW ARGUMENT: devices/users get: --fields-regex-root-only: to exclude complex field sub fields from selection
- NEW ARGUMENT: root group: --log-file-rotate: to force the log file to rotate
- NEW ARGUMENT: system discover start add: --wait: wait until discover finishes before returning
- NEW COMMAND: devices/users saved_query update-name
- NEW COMMAND: devices/users saved_query update-description
- NEW COMMAND: devices/users saved_query update-private
- NEW COMMAND: devices/users saved_query update-always-cached
- NEW COMMAND: devices/users saved_query update-tags
- NEW COMMAND: devices/users saved_query update-page_size
- NEW COMMAND: devices/users saved_query update-sort
- NEW COMMAND: devices/users saved_query update-query
- NEW COMMAND: devices/users saved_query update-fields
- NEW COMMAND: devices/users saved_query copy

API Library

API Library fixes

- devices/users.get explode=True would only populate values for the first entry
- devices/users.saved_query.validate with fields_regex should not return "all" field
- devices/users.saved_query.validate with fields_regex should not return "raw_data" field
- devices/users.saved_query.add/update: SQ 'query_type' not always returned, added safe default
- devices/users.saved_query.*: SQ gui page sizes now 20,50,100, not 25,50,100
- devices/users.get: table export format was not paying attention to table_format
- devices/users.get: table export format was not paying attention to table_max_rows
- query wizard: query building was failing, double quotes are now needed around field name
- adapters.get: get_clients=True throwing exception
- package: add pyOpenSSL as dependency
- package: many underlying fixes done to ApiEndpoints, API models, and dataclass models & schemas
- package: coverage increase from 76% to 96%

API Library Enhancements

- data models: add support for dataclasses to be referenced as dictionaries
- devices.saved_query.get*: sq as dataclass or dict
- devices.saved_query.*: notfounderror show more metadata on each SQ
- NEW ARGUMENT: devices/users.fields.validate: 'fields_regex_root_only' to exclude complex field sub fields from selection
- NEW ARGUMENT: devices.saved_query.add(): 'asset_scope' and 'wiz_entries'
- NEW METHOD: devices/users.saved_query.copy
- NEW METHOD: devices/users.saved_query.get_by_multi
- NEW METHOD: devices/users.saved_query.update_always_cached
- NEW METHOD: devices/users.saved_query.update_description
- NEW METHOD: devices/users.saved_query.update_fields
- NEW METHOD: devices/users.saved_query.update_name
- NEW METHOD: devices/users.saved_query.update_page_size
- NEW METHOD: devices/users.saved_query.update_private
- NEW METHOD: devices/users.saved_query.update_query
- NEW METHOD: devices/users.saved_query.update_sort
- NEW METHOD: devices/users.saved_query.update_tags
- package: remove raw_data feature, built in to product now

AXONSHELL

FIXES

- deleting saved query now prints the name correctly

NEW COMMANDS

n/a

NEW ARGUMENTS

n/a

ENHANCEMENTS

n/a

API Library

FIXES

QUERY WIZARD

- compOp must be empty string!
- field must be saved_query not specific_data.sq!
- add index for parent expression entries
- temp. disabled column filters due to object shape change

NEW METHODS

n/a

NEW ARGUMENTS

n/a

ENHANCEMENTS

n/a

AXONSHELL

FIXES

n/a

NEW COMMANDS

n/a

NEW ARGUMENTS

n/a

ENHANCEMENTS

n/a

API Library

FIXES

NEW METHODS

n/a

NEW ARGUMENTS

n/a

ENHANCEMENTS

Field schemas
- Unknown/unexpected field schemas will no longer error out
- they will now throw a warning and fallback to a string type

API Query Wizard

- Added saved query support via:
simple sq equals $NAME_OF_SQ

AXONSHELL

FIXES

n/a

NEW COMMANDS

n/a

NEW ARGUMENTS

n/a

ENHANCEMENTS

n/a

API Library

FIXES

devices/users.get

- Performance improved when using 'field_explode': no longer using copy.deepcopy()

NEW METHODS

n/a

NEW ARGUMENTS

n/a

ENHANCEMENTS

- Add debug timing for asset callbacks
- Improved handling for non-strict schemas
- Add support for new field format 'string-date'

**This version will ONLY work with Axonius 4.1 and later. If you are using a version of Axonius earlier than 4.1, you must use API Client v4.2.2!!**

AXONSHELL

NEW COMMANDS

axonshell system instances admin-script-upload
Provides the ability to upload and execute admin/license scripts provided by Axonius. Similar to going to /administration URL in GUI.


Upload a script from a file:
axonshell system instances admin-script-upload --path /path/to/file

Upload a script from a URL (must begin with http or https):
axonshell system instances admin-script-upload --path https://domain/path/to/file


axonshell help-features
List all available "Features" that can be enabled and how to enable them.


axonshell help-features


axonshell openapi get-spec
Download the OpenAPI Specification file for the REST API in YAML format.


axonshell openapi get-spec


NEW ARGUMENTS

axonshell devices get & axonshell users get: fields-error
Allows user to ignore errors in fields supplied when getting assets.


ignore errors for unknown field name:
axonshell devices get --field badwolf --no-fields-error

ignore errors for no fields supplied:
axonshell devices get --no-fields-default --no-fields-error


axonshell tools system-status: wait, sleep, max-wait
Makes the command wait until the system reports as fully booted and ready before returning.


Keep polling every 30 seconds (the default):
axonshell tools system-status --wait

Keep polling every 5 seconds:
axonshell tools system-status --wait --sleep 5

Keep polling but only for a maximum of 5 minutes (default is 15 minutes):
axonshell tools system-status --wait --max-wait 300


ENHANCEMENTS

New feature: raw_data
Provides the ability to get aggregated or adapter specific raw data.

Can be enabled via:

In bash/zsh:
export AX_FEATURES='raw_data'

In CMD:
set AX_FEATURES=raw_data

Add a line to the .env file with:
AX_FEATURES=raw_data


Allows supplying 'agg:raw_data' or 'adapter_name:raw_data' to the --field argument for getting assets, i.e.:

Get the raw data for all adapters for all device assets:
axonshell devices get --field agg:raw_data

Get the raw data for just the aws adapter for all device assets:
axonshell devices get --field aws:raw_data


API Library

NEW METHODS

client.instances.admin_script_upload_path
Provides the ability to upload and execute admin/license scripts provided by Axonius. Similar to going to /administration URL in GUI.


Upload a script from a file:
result = client.instances.admin_script_upload_path(path='/path/to/file')

Upload a script from a URL (must begin with http or https):
result = client.instances.admin_script_upload_path(path='https://domain/path/to/file')


client.openapi.get_spec
Download the OpenAPI Specification file for the REST API in YAML format.


data = client.openapi.get_spec()


NEW ARGUMENTS

client.devices.get & client.users.get: fields_error
Allows user to ignore errors in fields supplied when getting assets.


ignore errors for unknown field name:
assets = client.devices.get(fields=['badwolf'], fields_error=False)

ignore errors for no fields supplied:
assets = client.devices.get(fields_default=False, fields_error=False)


ENHANCEMENTS

Features
Added a new concept called "Features" for enabling usage of features not yet in the current published versions of Axonius.


Print help for all features:
for f in axonius_api_client.features.Features.get_features():
print(f)


New Feature: raw_data
Provides the ability to get aggregated or adapter specific raw data.

Can be enabled via:

use the force attribute on the feature:
axonius_api_client.features.Features.raw_data.force = true

set an OS environment variable:
import os; os.environ["AX_FEATURES"] = 'raw_data'


Allows supplying 'agg:raw_data' or 'adapter_name:raw_data' to the fields argument for getting assets:

raw data for all adapters for all device assets:
client.devices.get(fields=["agg:raw_data"])

raw data for just the aws adapter for all device assets:
client.devices.get(fields=["aws:raw_data"])

raw data for all adapters for all user assets:
client.users.get(fields=["agg:raw_data"])

raw data for just the active_directory adapter for all user assets:
client.users.get(fields=["active_directory:raw_data"])


Schema improvements
- Overcome schema differences between 4.1 and forthcoming versions of Axonius
- SystemRole: Add new optional attribute `users_count: int`
- SystemUser: Modified how `ignore_role_assignment_rules: bool` gets excluded for older versions

**This version will ONLY work with Axonius 4.1 and later. If you are using a version of Axonius earlier than 4.1, you must use API Client v4.2.2!!**

CLI
- NEW COMMAND: axonshell system settings-global configure-destroy
- enable / disable dangerous advanced API system settings
- NEW COMMAND: axonshell system instances factory-reset
- reset a core instance back to factory / fresh install state
- NEW COMMAND: axonshell tools system-status
- get the current status of a core instance (booting, ready, unknown, awaiting factory reset)
- exit code is 0 if ready
- BUGFIX COMMAND: axonshell system users add
- addressed issues with generate/email password reset token
- BUGFIX COMMAND: axonshell system users update
- fixed to work with new set methods in client.system_users

API
- NEW METHOD: client.settings_global.configure_destroy()
- enable / disable dangerous advanced API system settings
- NEW METHOD: client.instances.factory_reset()
- reset a core instance back to factory / fresh install state
- NEW PROPERTY: client.signup.system_status
- get the current status of a core instance (booting, ready, unknown, awaiting factory reset)
- unauthenticated endpoint
- ENHANCEMENT: client.settings_global.update_section()
- added check_unchanged=True to signature, if false doesn't throw an error if no changes supplied
- BUGFIX: axonius_api_client.tools.sysinfo()
- handle python interpreters without sys.argv
- specific use case: phantom integration