https://github.com/defectdojo/defectdojo_api
Python API library for DefectDojo
https://github.com/defectdojo/defectdojo_api
Last synced: 9 months ago
JSON representation
Python API library for DefectDojo
- Host: GitHub
- URL: https://github.com/defectdojo/defectdojo_api
- Owner: DefectDojo
- License: mit
- Created: 2016-11-28T02:19:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T17:27:02.000Z (almost 3 years ago)
- Last Synced: 2025-04-12T08:26:04.466Z (9 months ago)
- Language: Python
- Size: 252 KB
- Stars: 41
- Watchers: 15
- Forks: 79
- Open Issues: 23
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
THIS API WRAPPER IS NO LONGER MAINTAINED. IT MAY OR MAY NOT WORK
========
See `clients and api wrappers in the docs `_ for alternatives
DefectDojo API
==============
A Python API wrapper for `DefectDojo `_, an AppSec and Security Vulnerability Management tool.
This package implements API functionality available within Dojo.
Quick Start
-----------
Several quick start options are available:
- Clone the repository: :code:`git clone https://github.com/DefectDojo/defectdojo_api`
- Install with pip (not recommended): :code:`pip install git+https://github.com/DefectDojo/defectdojo_api#master`
- If you are testing the api locally make sure to set the PYTHONPATH. export PYTHONPATH=/path/totheapi/defectdojo_api:$PYTHONPATH
Example
-------
.. code-block:: python
# import the package
from defectdojo_api import defectdojo
# setup DefectDojo connection information
host = 'http://localhost:8000/'
api_key = 'your_api_key_from_DefectDojo'
user = 'admin'
# instantiate the DefectDojo api wrapper
dd = defectdojo.DefectDojoAPI(host, api_key, user, debug=False)
# If you need to disable certificate verification, set verify_ssl to False.
# dd = defectdojo.DefectDojoAPI(host, api_key, user, verify_ssl=False)
# Create a product
prod_type = 1 #1 - Research and Development, product type
product = dd.create_product("API Product Test", "This is a detailed product description.", prod_type)
if product.success:
# Get the product id
product_id = product.id()
print "Product successfully created with an id: " + str(product_id)
#List Products
products = dd.list_products()
if products.success:
print(products.data_json(pretty=True)) # Decoded JSON object
for product in products.data["objects"]:
print(product['name']) # Print the name of each product
else:
print products.message
More examples `available `_ on Github.
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 `_.
Copyright and License
---------------------
- `Licensed under MIT `_.