{"id":20513475,"url":"https://github.com/defectdojo/defectdojo_api","last_synced_at":"2025-04-13T23:52:32.411Z","repository":{"id":13778525,"uuid":"74929071","full_name":"DefectDojo/defectdojo_api","owner":"DefectDojo","description":"Python API library for DefectDojo","archived":false,"fork":false,"pushed_at":"2023-02-24T17:27:02.000Z","size":258,"stargazers_count":41,"open_issues_count":23,"forks_count":79,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-12T08:26:04.466Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DefectDojo.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-11-28T02:19:32.000Z","updated_at":"2025-01-29T10:26:53.000Z","dependencies_parsed_at":"2023-01-13T17:37:04.171Z","dependency_job_id":"e9b1214b-28ea-482a-849a-6c7ef6777df4","html_url":"https://github.com/DefectDojo/defectdojo_api","commit_stats":{"total_commits":100,"total_committers":29,"mean_commits":"3.4482758620689653","dds":0.78,"last_synced_commit":"969f97a51fb3598f8c5ab3c71f3da5426d39c33f"},"previous_names":["aaronweaver/defectdojo_api"],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fdefectdojo_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fdefectdojo_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fdefectdojo_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fdefectdojo_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DefectDojo","download_url":"https://codeload.github.com/DefectDojo/defectdojo_api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248799898,"owners_count":21163400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T21:11:19.393Z","updated_at":"2025-04-13T23:52:32.375Z","avatar_url":"https://github.com/DefectDojo.png","language":"Python","readme":"THIS API WRAPPER IS NO LONGER MAINTAINED. IT MAY OR MAY NOT WORK\n========\n\nSee `clients and api wrappers in the docs \u003chttps://defectdojo.github.io/django-DefectDojo/integrations/api-v2-docs/#clients--api-wrappers\u003e`_ for alternatives\n\n\nDefectDojo API\n==============\n\nA Python API wrapper for `DefectDojo \u003chttps://github.com/OWASP/django-DefectDojo\u003e`_, an AppSec and Security Vulnerability Management tool.\n\nThis package implements API functionality available within Dojo.\n\nQuick Start\n-----------\n\nSeveral quick start options are available:\n\n- Clone the repository: :code:`git clone https://github.com/DefectDojo/defectdojo_api`\n- Install with pip (not recommended): :code:`pip install git+https://github.com/DefectDojo/defectdojo_api#master`\n\n- If you are testing the api locally make sure to set the PYTHONPATH. export PYTHONPATH=/path/totheapi/defectdojo_api:$PYTHONPATH\n\nExample\n-------\n\n.. code-block:: python\n\n    # import the package\n    from defectdojo_api import defectdojo\n\n    # setup DefectDojo connection information\n    host = 'http://localhost:8000/'\n    api_key = 'your_api_key_from_DefectDojo'\n    user = 'admin'\n\n    # instantiate the DefectDojo api wrapper\n    dd = defectdojo.DefectDojoAPI(host, api_key, user, debug=False)\n\n    # If you need to disable certificate verification, set verify_ssl to False.\n    # dd = defectdojo.DefectDojoAPI(host, api_key, user, verify_ssl=False)\n\n    # Create a product\n    prod_type = 1 #1 - Research and Development, product type\n    product = dd.create_product(\"API Product Test\", \"This is a detailed product description.\", prod_type)\n\n    if product.success:\n        # Get the product id\n        product_id = product.id()\n        print \"Product successfully created with an id: \" + str(product_id)\n\n    #List Products\n    products = dd.list_products()\n\n    if products.success:\n        print(products.data_json(pretty=True))  # Decoded JSON object\n\n        for product in products.data[\"objects\"]:\n            print(product['name'])  # Print the name of each product\n    else:\n        print products.message\n\nMore examples `available \u003chttps://github.com/aaronweaver/defectdojo_api/tree/master/examples\u003e`_ on Github.\n\nSupporting information for each method available can be found in the `documentation \u003chttps://defectdojo-api.readthedocs.io\u003e`_.\n\nBugs and Feature Requests\n-------------------------\n\nHave 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 \u003chttps://github.com/aaronweaver/defectdojo_api/issues/new\u003e`_.\n\nCopyright and License\n---------------------\n\n- `Licensed under MIT \u003chttps://github.com/aaronweaver/defectdojo_api/blob/master/LICENSE.txt\u003e`_.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefectdojo%2Fdefectdojo_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefectdojo%2Fdefectdojo_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefectdojo%2Fdefectdojo_api/lists"}