getappbuilds.do
The getappbuilds.do
call compiles a detailed list of applications and statuses, including all the application and scan profile data.
Before using this API, Veracode strongly recommends that you read API usage and access guidelines. Ensure you access the APIs with the domain for your region.
The default is to include the latest published report for each application if it has changed in the last 31 days. This API returns data from the latest scan of an application. If you want to obtain more than just the data from the latest scan, use getapplist.do
to generate a list of applications and getbuildlist.do
to generate a list of scans for an application. You can then use getappinfo.do
and getbuildinfo.do
to retrieve the data about specific applications and scans.
REST API equivalent
The REST API equivalent of this call is a GET
to /appsec/v1/applications
using the Applications API and the Findings API. Veracode strongly recommends that you use the REST API for this action. For new integrations, always use the REST APIs.
Resource URL
https://analysiscenter.veracode.com/api/4.0/getappbuilds.do
Parameters
Name | Type | Description |
---|---|---|
report_changed_since | String | Format: mm/dd/yyyy . Scan data is only included for scans of applications with changed or published reports since the specified date. Changes to a report include:
31 days ago. |
only_latest | Boolean | Set to true to return the latest scan data for each application. Set to false to return scan data for all previous scans that have published reports. Default is true . |
HTTPie example
Examples use the HTTPie command-line tool.
http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/4.0/getappbuilds.do" "report_changed_since==08/25/2019"
HTTPie results
The getappbuilds.do
call returns the appbuilds
XML document, which references the applicationbuilds.xsd
schema file. You can use the XSD schema file to validate the XML data.
A partial XML example. Veracode has deprecated assurance_level
and replaced it with business_criticality
.
<?xml version="1.0" encoding="UTF-8"?>
<applicationbuilds xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://analysiscenter.veracode.com/schema/2.0/applicationbuilds"
xsi:schemaLocation="https://analysiscenter.veracode.com/schema/2.0/applicationbuilds
https://analysiscenter.veracode.com/resource/2.0/applicationbuilds.xsd" account_id="<account id>">
<application app_name="<app name>" app_id="<app id>" industry_vertical="Manufacturing" assurance_level="Very High"
business_criticality="Very High" origin="Not Specified" modified_date="2019-08-13T14:00:10-04:00"
cots="false" business_unit="Not Specified" tags="">
<customfield name="Custom 1" value=""/>
<customfield name="Custom 2" value=""/>
<customfield name="Custom 3" value=""/>
<customfield name="Custom 4" value=""/>
<customfield name="Custom 5" value=""/>
<customfield name="Custom 6" value=""/>
<customfield name="Custom 7" value=""/>
<customfield name="Custom 8" value=""/>
<customfield name="Custom 9" value=""/>
<customfield name="Custom 10" value=""/>
</application>
</applicationbuilds>
<!-- Parameters: report_changed_since=08/25/2019 only_latest=true -->
Use getapplist.do
or getbuildlist.do
to get scan information for multiple applications. If you use Archer, use the Archer asynchronous APIs to quickly obtain a detailed list of applications and statuses.
Java wrapper example
java -jar vosp-api-wrapper-java{version}.jar -vid <Veracode API ID> -vkey <Veracode API Key> -action getappbuilds -reportchangedsince 08/25/2019
C# wrapper example
VeracodeC#API -vid <Veracode API ID> -vkey <Veracode API key> -action getappbuilds -reportchangedsince 08/25/2019
API wrapper results
The getappbuilds.do
call returns the appbuilds
XML document, which references the applicationbuilds.xsd schema file. You can use the XSD schema file to validate the XML data.
A partial XML example. Veracode has deprecated assurance_level
and replaced it with business_criticality
.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<applicationbuilds xmlns="https://analysiscenter.veracode.com/schema/2.0/applicationbuilds"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" account_id="74370"
xsi:schemaLocation="https://analysiscenter.veracode.com/schema/2.0/applicationbuilds
https://analysiscenter.veracode.com/resource/2.0/applicationbuilds.xsd">
<application app_id="<app id>" app_name="<app name>" assurance_level="Medium"
business_criticality="Medium" business_owner="Veracode"
business_unit="Mobile Secure Ventures" cots="false" industry_vertical="Not Specified"
modified_date="2019-09-20T00:01:27-04:00" origin="Not Specified" tags="">
<customfield name="Custom 1" value=""/>
<customfield name="Custom 2" value=""/>
<customfield name="Custom 3" value=""/>
<customfield name="Custom 4" value=""/>
<customfield name="Custom 5" value=""/>
<customfield name="Custom 6" value=""/>
<customfield name="Custom 7" value=""/>
<customfield name="Custom 8" value=""/>
<customfield name="Custom 9" value=""/>
<customfield name="Custom 10" value=""/>
<build build_id="5003771" grace_period_expired="false" lifecycle_stage="Not Specified"
platform="Not Specified" policy_compliance_status="Did Not Pass"
policy_name="Veracode Recommended Medium" policy_version="1" results_ready="true"
rules_status="Did Not Pass" scan_overdue="false" submitter="<VeracodeUserName>"
version="App Dynamic Scan">
<analysis_unit analysis_type="Dynamic" published_date="2019-09-20T00:01:13-04:00"
published_date_sec="1568952073" status="Results Ready"/>
</build>
</application>
<application app_id="<app id>" app_name="<app name>" assurance_level="Very High"
business_criticality="Very High" business_unit="Not Specified" cots="false"
industry_vertical="Not Specified" modified_date="2019-10-03T16:07:50-04:00"
origin="Not Specified" tags="">
<customfield name="Custom 1" value=""/>
<customfield name="Custom 2" value=""/>
<customfield name="Custom 3" value=""/>
<customfield name="Custom 4" value=""/>
<customfield name="Custom 5" value=""/>
<customfield name="Custom 6" value=""/>
<customfield name="Custom 7" value=""/>
<customfield name="Custom 8" value=""/>
<customfield name="Custom 9" value=""/>
<customfield name="Custom 10" value=""/>
</application>
</applicationbuilds><!-- Parameters: report_changed_since=08/25/2019
only_latest=true -->