/veracode-api-py

Python helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.

Primary LanguagePythonMIT LicenseMIT

Veracode API Python

Python helper library for working with the Veracode APIs. Handles retries, pagination, and other features of the modern Veracode REST APIs.

Not an official Veracode product. Heavily based on original work by CTCampbell.

Setup

Install from pypi:

pypi veracode_api_py

(Optional) Save Veracode API credentials in ~/.veracode/credentials

[default]
veracode_api_key_id = <YOUR_API_KEY_ID>
veracode_api_key_secret = <YOUR_API_KEY_SECRET>

Use in your applications

Import VeracodeAPI or one of the individual API classes into your code and call the methods. Most methods return JSON or XML depending on the underlying API.

You can find sample scripts for some APIs in the Samples folder.

Docs

For detailed documentation on the available methods, please see the veracode-api-py docs.

Notes

  1. Different API calls require different roles. Consult the Veracode Docs.

  2. This library does not include a complete set of Veracode API methods. In particular, it only provides a handful of XML API methods.

  3. To use this library (or a script based on it) with a proxy server, you can set environment variables with the addresses of the proxies:

    • export HTTP_PROXY='http://10.10.10.10:8000'
    • export HTTPS_PROXY='http://10.10.10.10:1212'

  4. Contributions are welcome. See the Contributions guidelines.