API usage guidelines

The XML APIs, REST APIs, and API wrappers have specific prerequisites, but there are general guidelines that apply to all APIs.

• To access the Veracode APIs, you must have a Veracode account with the required roles and Veracode API credentials. See Accessing Veracode APIs and Create an API user.
• For the best experience when using the APIs and wrappers, Veracode strongly recommends that you review the API best practices.
• Veracode reserves the right to apply API rate limiting to any account that exceeds the allowed number of API requests within a specific period.
• You cannot use Veracode API credentials with cURL, but you can use them with the HTTPie command-line tool.
• For instructions on using Veracode APIs with Postman, see the REST APIs quickstart.
• To test the security of your API specifications, see Scan APIs.

note

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.