Assets

Methods described in this section relate to the assets API. These methods can be accessed at TenableOne.inventory.assets.

class AssetsAPI(api: APISession)

list(query_text: str | None = None, query_mode: QueryMode | None = None, filters: list[PropertyFilter] | None = None, extra_properties: list[str] | None = None, offset: int | None = None, limit: int | None = None, sort_by: str | None = None, sort_direction: SortDirection | None = None) → Assets

Retrieve assets

Parameters:

• query_text (str, optional) – The text to search for.

• query_mode (QueryMode, optional) – The search mode. Defaults to QueryMode.SIMPLE.

• filters (list, optional) – A list of filters to apply. Defaults to None.

• extra_properties (list, optional) – Additional properties to include in the response. Defaults to None.

• offset (int, optional) – Number of records to skip. Defaults to 0.

• limit (int, optional) – Maximum number of records per page. Defaults to 1000.

• sort_by (str, optional) – Field to sort by.

• sort_direction (SortDirection, optional) – Sorting direction, either SortDirection.ASC or SortDirection.DESC.

Returns:

The request assets.

Return type:

Asset

Examples

>>> assets = tenable_inventory.assets.list()
>>> for asset in assets:
...     pprint(asset)

list_properties(asset_classes: list[AssetClass] | None = None) → list[Field]

Retrieve assets properties

Parameters:

asset_classes (list[str], optional) – Getting properties for specific asset classes If this parameter is omitted, Tenable returns properties for all asset classes. For example: asset_classes=[AssetClass.DEVICE].

Returns:

The asset properties.

Return type:

list[Field]

Examples

>>> tenable_inventory_asset_properties = tenable_inventory.assets.list_properties()
>>> for asset_property in asset_properties:
...     pprint(asset_property)