Filters

The following methods allow for interaction into the Tenable Vulnerability Management filters API endpoints.

Methods available on tio.filters:

class FiltersAPI(api: APISession)

This will contain all methods related to filters

access_group_asset_rules_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns access group rules filters.

filters: access-control-rules-filters

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.access_group_rules_filters()

access_group_asset_rules_filters_v2(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns access group rules filters v2.

filters: access_group_asset_rules_filters_v2

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.access_group_rules_filters_v2()

access_group_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns access group filters.

filters: access-group-filters

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.access_group_filters()

access_group_filters_v2(normalize=True)

Returns access group filters v2.

filters: access_group_filters_v2

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.access_group_filters_v2()

agents_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns agent filters.

filters: agents-filters

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.agents_filters()

asset_tag_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns a list of filters that you can use to create the rules for applying dynamic tags.

tag: list asset tag filters

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> tio.filters.asset_tag_filters()

credentials_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns the individual scan filters.

filters: credentials

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.scan_filters()

networks_filters() → dict[str, Any]

Returns the networks filters.

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.network_filters()

scan_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns the individual scan filters.

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.scan_filters()

workbench_asset_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns the asset workbench filters.

workbenches: assets-filters

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.workbench_asset_filters()

workbench_vuln_filters(normalize: bool = True, expire_age: int = 60) → dict[str, Any]

Returns the vulnerability workbench filters

workbenches: vulnerabilities-filters

Parameters:

• normalize – Should the response be converted into the same structure used for the filter cache?

• expire_age – How many seconds old can the cache be before forcing a refresh?

Returns:

Filter resource dictionary

Return type:

dict

Examples

>>> filters = tio.filters.workbench_vuln_filters()