createbuild.do

APIs

The createbuild.do call creates a new build of an existing application in the portfolio. The uploadfile.do call also creates a build, therefore it is not necessary to use this call as part of the Upload API workflow.
Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Resource URL

https://analysiscenter.veracode.com/api/5.0/createbuild.do

Parameters

app_id Integer. Required.  
version String. Required. You must specify a version number unique to ones used for previous builds.  
platform String. Validates against the platform enums. Defaults to Not Specified. Only used if platform_id is not provided. Do not use this parameter. This is a deprecated parameter that is no longer supported, but is maintained for backwards compatibility.
lifecycle_stage String. Validates against the names of the lifecycle enums. Defaults to Not Specified. Only used if lifecycle_stage_id is not provided. Case-sensitive enum values include:
  • In Development. This category includes pre-Alpha.
  • Internal or Alpha Testing
  • External or Beta Testing
  • Deployed. This category includes in production and actively developed.
  • Maintenance. This category includes only bug fixes.
  • Cannot Disclose
launch_date String. Validates against the mm/dd/yyy date format. No default.  
sandbox_id Integer. Optional. Enter the ID of the sandbox for which you want to create a build.  

Example

 curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/createbuild.do -F "app_id=10886" -F
          "version=v1" –F “legacy_scan_engine =true” 

Results

The createbuild.do call returns the buildinfo XML document, which references the buildinfo.xsd. Additional buildinfo.xsd schema documentation is available. Use the XSD file to validate the XML data. The following is an example of returned XML.
<?xml version="1.0" encoding="UTF-8"?>

<buildinfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://analysiscenter.veracode.com/schema/4.0/buildinfo" xsi:schemaLocation="https://analysiscenter.veracode.com/schema/4.0/buildinfo https://analysiscenter.veracode.com/resource/4.0/buildinfo.xsd" buildinfo_version="1.3" account_id="10241" app_id="10886" build_id="14316">
<build version="APItesting" build_id="14316" submitter="Leonard McCoy" platform="Not Specified" lifecycle_stage="Not Specified" results_ready="false" policy_name="Veracode Recommended Low" policy_version="1" policy_compliance_status="Calculating..." rules_status="Calculating..." grace_period_expired="false" scan_overdue="false" legacy_scan_engine="true">
<analysis_unit analysis_type="Static" status="Incomplete" engine_version="69177"/>
</build>
</buildinfo>