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.

Source Distribution

threadfix_api-1.1.1.zip (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

threadfix_api-1.1.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file threadfix_api-1.1.1.zip.

File metadata

  • Download URL: threadfix_api-1.1.1.zip
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for threadfix_api-1.1.1.zip
Algorithm Hash digest
SHA256 7ddac66031178cbe483ce93dcd14e017c59f243618d3f05d6980425d7d677047
MD5 79d48b23e055e8d2f3c35d9e0aae0817
BLAKE2b-256 ac8292038be5318ba55de475c86e9879c42ae47b8fc29575df8add83a037ce7f

See more details on using hashes here.

File details

Details for the file threadfix_api-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for threadfix_api-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0516470787d5d0d0ee4c769d0754d9da553d9f3cbdfb451de01f4d06343059f9
MD5 655cb905207d518d3dcbbb815692f2ee
BLAKE2b-256 f11c0336308c036d2ffc215144e1b7a81de2d2c5edef8891b91d8a3aabc83801

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page