Tenable Vulnerability Management

class TenableIO(access_key: Optional[str] = None, secret_key: Optional[str] = None, **kwargs)[source]

The Tenable Vulnerability Management object is the primary interaction point for users to interface with Tenable Vulnerability Management via the pyTenable library. All the API endpoint classes that have been written will be grafted onto this class.

Parameters

  • access_key (str, optional) – The user’s API access key for Tenable Vulnerability Management. If an access key isn’t specified, then the library will attempt to read the environment variable TIO_ACCESS_KEY to acquire the key.

  • secret_key (str, optional) – The user’s API secret key for Tenable Vulnerability Management. If a secret key isn’t specified, then the library will attempt to read the environment variable TIO_SECRET_KEY to acquire the key.

  • url (str, optional) – The base URL that the paths will be appended onto. The default is https://cloud.tenable.com

  • retries (int, optional) – The number of retries to make before failing a request. The default is 5.

  • backoff (float, optional) – If a 429 response is returned, how much do we want to backoff if the response didn’t send a Retry-After header. The default backoff is 1 second.

  • vendor (str, optional) – The vendor name for the User-Agent string.

  • product (str, optional) – The product name for the User-Agent string.

  • build (str, optional) – The version or build identifier for the User-Agent string.

  • timeout (int, optional) – The connection timeout parameter informing the library how long to wait in seconds for a stalled response before terminating the connection. If unspecified, the default is 120 seconds.

Examples

Basic Example:

>>> from tenable.io import TenableIO
>>> tio = TenableIO('ACCESS_KEY', 'SECRET_KEY')

Example with proper identification:

>>> tio = TenableIO('ACCESS_KEY', 'SECRET_KEY',
>>>     vendor='Company Name',
>>>     product='My Awesome Widget',
>>>     build='1.0.0')

Example with proper identification leveraging environment variables for access and secret keys:

>>> tio = TenableIO(
>>>     vendor='Company Name', product='Widget', build='1.0.0')
property access_groups

The interface object for the Tenable Vulnerability Management Access Groups APIs.

property access_groups_v2

The interface object for the Tenable Vulnerability Management Access Groups v2 APIs.

property agent_config

The interface object for the Tenable Vulnerability Management Agent Config APIs.

property agent_exclusions

The interface object for the Tenable Vulnerability Management Agent Exclusions APIs.

property agent_groups

The interface object for the Tenable Vulnerability Management Agent Groups APIs.

property agents

The interface object for the Tenable Vulnerability Management Agents APIs.

property assets

The interface object for the Tenable Vulnerability Management assets APIs.

property audit_log

The interface object for the Tenable Vulnerability Management Audit Log APIs.

property credentials

The interface object for the Tenable Vulnerability Management Credentials APIs.

property cs

The interface object for the Tenable Vulnerability Management Container Security APIs.

property editor

The interface object for the Tenable Vulnerability Management Editor APIs.

property exclusions

The interface object for the Tenable Vulnerability Management Exclusions APIs.

property exports

The interface object for the Tenable Vulnerability Management Exports APIs.

property files

The interface object for the Tenable Vulnerability Management Files APIs.

property filters

The interface object for the Tenable Vulnerability Management Filters APIs.

property folders

The interface object for the Tenable Vulnerability Management Folders APIs.

property groups

The interface object for the Tenable Vulnerability Management Groups APIs.

property networks

The interface object for the Tenable Vulnerability Management Networks APIs.

property permissions

The interface object for the Tenable Vulnerability Management Permissions APIs.

property plugins

The interface object for the Tenable Vulnerability Management Plugins APIs.

property policies

The interface object for the Tenable Vulnerability Management Policies APIs.

property remediationscans

The interface object for the Tenable Vulnerability Management Remediation Scans APIs.

property scanner_groups

The interface object for the Tenable Vulnerability Management Scanner Groups APIs.

property scanners

The interface object for the Tenable Vulnerability Management Scanners APIs.

property scans

The interface object for the Tenable Vulnerability Management Scans APIs.

property server

The interface object for the Tenable Vulnerability Management Server APIs.

property session

The interface object for the Tenable Vulnerability Management Session APIs.

property tags

The interface object for the Tenable Vulnerability Management Tags APIs.

property target_groups

The interface object for the Tenable Vulnerability Management Target Groups APIs.

property users

The interface object for the Tenable Vulnerability Management Users APIs.

property v3

The interface object for the Tenable Vulnerability Management v3 APIs.

property was

The interface object for the Tenable Vulnerability Management WAS APIs.

property workbenches

The interface object for the Tenable Vulnerability Management Workbenches APIs.