Tenable.io¶

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

The Tenable.io object is the primary interaction point for users to interface with Tenable.io via the pyTenable library. All of 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.io 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.io 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.io Access Groups APIs.

property access_groups_v2¶: The interface object for the Tenable.io Access Groups v2 APIs.

property agent_config¶: The interface object for the Tenable.io Agent Config APIs.

property agent_exclusions¶: The interface object for the Tenable.io Agent Exclusions APIs.

property agent_groups¶: The interface object for the Tenable.io Agent Groups APIs.

property agents¶: The interface object for the Tenable.io Agents APIs.

property assets¶: The interface object for the Tenable.io assets APIs.

property audit_log¶: The interface object for the Tenable.io Audit Log APIs.

property credentials¶: The interface object for the Tenable.io Credentials APIs.

property cs¶: The interface object for the Tenable.io Container Security APIs.

property editor¶: The interface object for the Tenable.io Editor APIs.

property exclusions¶: The interface object for the Tenable.io Exclusions APIs.

property exports¶: The interface object for the Tenable.io Exports APIs.

property files¶: The interface object for the Tenable.io Files APIs.

property filters¶: The interface object for the Tenable.io Filters APIs.

property folders¶: The interface object for the Tenable.io Folders APIs.

property groups¶: The interface object for the Tenable.io Groups APIs.

property networks¶: The interface object for the Tenable.io Networks APIs.

property permissions¶: The interface object for the Tenable.io Permissions APIs.

property plugins¶: The interface object for the Tenable.io Plugins APIs.

property policies¶: The interface object for the Tenable.io Policies APIs.

property remediationscans¶: The interface object for the Tenable.io Remediation Scans APIs.

property scanner_groups¶: The interface object for the Tenable.io Scanner Groups APIs.

property scanners¶: The interface object for the Tenable.io Scanners APIs.

property scans¶: The interface object for the Tenable.io Scans APIs.

property server¶: The interface object for the Tenable.io Server APIs.

property session¶: The interface object for the Tenable.io Session APIs.

property tags¶: The interface object for the Tenable.io Tags APIs.

property target_groups¶: The interface object for the Tenable.io Target Groups APIs.

property users¶: The interface object for the Tenable.io Users APIs.

property v3¶: The interface object for the Tenable.io v3 APIs.

property was¶: The interface object for the Tenable.io WAS APIs.

property workbenches¶: The interface object for the Tenable.io Workbenches APIs.