The Veracode REST and XML APIs mirror the main tasks for scanning applications, reviewing results, mitigating findings, and administrating your organization in the Veracode Platform. Veracode strongly recommends that you use the REST APIs. For new integrations, always use the REST APIs.
To get started quickly, see the REST APIs Quickstart.
To understand how the APIs work, Veracode 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, then reviewing the results, you can integrate the API calls directly into your IDE and build system code to scan early and often.
Veracode APIs and integrations require access to specific Region Domains, depending on the region for your Veracode account. Contact your IT team to ensure the correct domains for your region are on the allowlist for your organization. Also, ensure that there is one-way communication on port 443 to the domain for the REST APIs. Refer to the complete list of domains and IP addresses to add to your allowlist.
Veracode REST APIs
The REST APIs follow the OpenAPI industry standard specification. These APIs return JSON instead of XML, and require authentication using HMAC. 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 XML APIs are web APIs, each having a defined set of HTTP request messages that return structured response messages in XML.