Skip to content

denimgroup/threadfix-python-api

Repository files navigation

ThreadFix Pro API

A Python module to assist with the ThreadFix RESTFul API to administer scan artifacts and overall ThreadFix vulnerability administration.

Quick Start

Several quick start options are available:

Example

# import the package
from ThreadFixProApi import ThreadFixProAPI

# setup threadfix connection information
host = 'https://127.0.0.1:8443/threadfix/'
api_key = 'your_api_key_from_threadfix_professional'

# initialize threadfix pro api module
tfp = ThreadFixProAPI(host, api_key)

# If you need to disable certificate verification.
# tfp = ThreadFixProAPI(host, api_key, verify_ssl=False)

# List your threadfix pro teams
teams = tfp.Applications.TeamsAPI.list_teams()
if teams.success:
    print("{}".format(teams.data))

    for team in teams.data:
        print(team['name'])  # Print the name of each team
else:
    print("ERROR: {}".format(teams.message))

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

Bugs and Feature Requests

Found something that doesn't seem right or have a feature request? Please open a new issue.

Copyright and License

https://img.shields.io/github/license/target/threadfixproapi.svg?style=flat-square

  • Copyright 2020 Denim Group, Ltd. (based upon work by Target Brands, Inc.)