pytenable.readthedocs.io Open in urlscan Pro
2606:4700::6811:2052  Public Scan

Submitted URL: http://pytenable.readthedocs.io/
Effective URL: https://pytenable.readthedocs.io/en/stable/
Submission: On May 12 via api from GB — Scanned from GB

Form analysis 2 forms found in the DOM

GET search.html

<form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

GET //readthedocs.org/projects/pytenable/search/

<form id="flyout-search-form" class="wy-form" target="_blank" action="//readthedocs.org/projects/pytenable/search/" method="get">
  <input type="text" name="q" aria-label="Search docs" placeholder="Search docs">
</form>

Text Content

Contents Menu Expand Light mode Dark mode Auto light/dark mode
Hide navigation sidebar
Hide table of contents sidebar
Toggle site navigation sidebar
pyTenable 1.4.6 documentation
Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar
 * Tenable.io
   Toggle child pages in navigation
   * Container Security
     Toggle child pages in navigation
     * Images
     * Reports
     * Repositories
   * Access Groups v2
   * Access Groups
   * Agent Config
   * Agent Exclusions
   * Agent Groups
   * Agents
   * Assets
   * Audit Log
   * Credentials
   * Editor
   * Exclusions
   * Exports
   * Files
   * Filters
   * Folders
   * Groups
   * Networks
   * Permissions
   * Plugins
   * Policies
   * Remediation Scans
   * Scanner Groups
   * Scanners
   * Scans
   * Server
   * Session
   * Tags
   * Target Groups
   * Users
   * Workbenches
 * Tenable.sc
   Toggle child pages in navigation
   * Common Themes
   * Accept Risks
   * Alerts
   * Analysis
   * Asset Lists
   * Audit Files
   * Credentials
   * Current Session
   * Feeds
   * Files
   * Groups
   * Organizations
   * Plugins
   * Policies
   * Queries
   * Recast Risks
   * Repositories
   * Roles
   * Scan Instances
   * Scan Zones
   * Scanners
   * Scans
   * Status
   * System
   * Users
 * Tenable.ot
   Toggle child pages in navigation
   * Assets
 * Product Downloads
 * Tenable.ad
   Toggle child pages in navigation
   * About
   * APIKeys
   * Attack Type
   * Category
   * Checker
   * Checker Option
   * Dashboard
   * Directory
   * Infrastructure
   * LDAP Configuration
   * Lockout Policy
   * Preference
   * Profiles
   * Reason
   * Roles
   * SAML Configuration
   * Score
   * Topology
   * Users
   * Widget
 * Nessus
   Toggle child pages in navigation
   * Agent Groups
   * Agents
   * Editor
   * Files
   * Folders
   * Groups
   * Mail
   * Permissions
   * Plugins
   * Policies
   * Proxy
   * Scanners
   * Scans
   * Server
   * Settings
   * Software Update
   * Tokens
   * Users
 * Reports
 * Cross-Package Tooling
   Toggle child pages in navigation
   * Base Platform
   * Base Endpoint
   * Version 1 Base Classes
 * Common Components
 * Errors
 * Testing the Library

Let's Talk Docs: A podcast interviewing folks with new approaches to software
docs. Subscribe today!
Community Ad
Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar


WELCOME TO PYTENABLE’S DOCUMENTATION!¶

pyTenable is intended to be a pythonic interface into the Tenable application
APIs. Further by providing a common interface and a common structure between all
of the various applications, we can ease the transition from the vastly
different APIs between some of the products.

 * Issue Tracker: https://github.com/tenable/pyTenable/issues

 * Github Repository: https://github.com/tenable/pyTenable

Note

pyTenable version 1.2 is the first release to drop support for Python versions
less than 3.6. If you are still using any of these deprecated python versions
the 1.1 release will still work, however is no longer being actively developed
or maintained.


INSTALLATION¶

To install the most recent published version to pypi, its simply a matter of
installing via pip:

pip install pytenable


If your looking for bleeding-edge, then feel free to install directly from the
github repository like so:

pip install git+git://github.com/tenable/pytenable.git#egg=pytenable



GETTING STARTED¶

Lets assume that we want to get the list of scans that have been run on our
Tenable.io application. Performing this action is as simple as the following:

from tenable.io import TenableIO
tio = TenableIO('TIO_ACCESS_KEY', 'TIO_SECRET_KEY')
for scan in tio.scans.list():
   print('{status}: {id}/{uuid} - {name}'.format(**scan))


Getting started with Tenable.sc is equally as easy:

from tenable.sc import TenableSC
sc = TenableSC('SECURITYCENTER_NETWORK_ADDRESS')
sc.login('SC_USERNAME', 'SC_PASSWORD')
for vuln in sc.analysis.vulns():
   print('{ip}:{pluginID}:{pluginName}'.format(**vuln))


For more detailed information on what’s available, please refer to the
navigation section for the Tenable application you’re looking


LOGGING¶

Enabling logging for pyTenable is a simple matter of enabling debug logs through
the python logging package. An easy example is detailed here:

import logging
logging.basicConfig(level=logging.DEBUG)



LICENSE¶

The project is licensed under the MIT license.

Next
Tenable.io
Copyright © 2022, Tenable, Inc. | Built with Sphinx and @pradyunsg's Furo theme.
| Show Source
Contents
 * Welcome to pyTenable’s documentation!
   * Installation
   * Getting Started
   * Logging
   * License

  v: stable
Versions latest stable 1.4.6 1.4.4 1.4.3 1.3.3 1.3.2 1.3.1 1.3.0 1.2.8 1.1.4
1.0.7 0.3.29 On Read the Docs Project Home Builds Downloads On GitHub View
Search


--------------------------------------------------------------------------------

Hosted by Read the Docs · Privacy Policy