About Veracode APIs

Veracode APIs

The Veracode REST and XML APIs mirror the major steps you complete on the Veracode Platform, automating the scanning, reviewing, mitigating, and administrative tasks. To understand how the APIs work, Vercode recommends that you familiarize yourself with the Veracode Platform workflow for scanning applications first, before beginning to use the APIs. You also should be familiar with how APIs function.

Veracode APIs are designed for members of a software development team responsible for performing security checks on software code. They enable developers who work in rapid build-and-test cycles to fully automate security verification for entire software portfolios, and to integrate with internal build and bug-tracking systems. Instead of manually using the Veracode Platform to go through the individual steps of configuring and submitting a scan request and, then, reviewing the results, you can integrate the API calls directly into your IDE and build system code to scan early and often.

Note: Before you can access the XML APIs, your API service account must have the required API permissions.

Veracode REST APIs

The Veracode REST APIs follow the OpenAPI industry standard specification. These APIs return JSON instead of XML, and require authentication using HMAC. See Using the Veracode REST APIs. The Veracode REST APIs require Veracode API credentials.

You can access Veracode REST APIs using a tool that supports Veracode HMAC authentication, including the Java or Python authentication libraries.

Veracode XML APIs

The Veracode XML APIs are web APIs, each having a defined set of HTTP request messages that return structured response messages in XML. See Using the Veracode XML APIs.