Skip to main content

An API wrapper to facilitate interactions with ThreadFix.

Project description

A Python API wrapper to facilitate interactions with ThreadFix.

This package implements all API functionality available within ThreadFix 2.2.2 (Apr 30).

Quick Start

Several quick start options are available:

  • Install with pip (recommended): pip install threadfix_api
  • Download the latest release
  • Clone the repository: git clone https://github.com/aparsons/threadfix_api.git

Example

# import the package
from threadfix_api import threadfix

# setup threadfix connection information
host = 'http://localhost:8080/threadfix/'
api_key = 'your_api_key_from_threadfix'

# instantiate the threadfix api wrapper
tf = threadfix.ThreadFixAPI(host, api_key)

# If you need to disable certificate verification, set verify_ssl to False.
# tf = threadfix.ThreadFixAPI(host, api_key, verify_ssl=False)

# You can also specify a local cert to use as client side certificate, as a
# single file (containing the private key and the certificate) or as a tuple
# of both file's path.
# cert=('/path/server.crt', '/path/key')
# tf = threadfix.ThreadFixAPI(host, api_key, cert=cert)

# rock and roll
teams = tf.list_teams()
if teams.success:
    print(teams.data)  # Decoded JSON object

    for team in teams.data:
        print(team['name'])  # Print the name of each team
else:
    print('Uh Oh! ' + teams.message)

Supporting information for each method available can be found in the documentation.

Bugs and Feature Requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for threadfix_api, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size threadfix_api-1.1.1-py3-none-any.whl (8.6 kB) File type Wheel Python version 3.4 Upload date Hashes View
Filename, size threadfix_api-1.1.1.zip (14.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page