This table lists the XML API calls for managing scans of your applications. For more detailed information, see the topic for a specific call.
Veracode strongly recommends that you use the REST APIs. For new integrations, always use the REST APIs.
XML API Call | Description | Required Parameters | Optional Parameters | Scan Type | Equivalent REST API Call |
---|---|---|---|---|---|
beginprescan.do |
Initiates the prescan of an application. | app_id |
sandbox_id , auto_scan , scan_all_nonfatal_top_level_modules |
Static | |
beginscan.do |
Initiates the full scan of an application. | app_id and one of these parameters: modules , scan_all_top_level_modules , scan_previously_selected_modules , scan_selected_modules |
sandbox_id |
Static | |
createapp.do |
Creates a new application in the portfolio. | app_name , business_criticality |
description , vendor_id , policy , business_unit , business_owner , business_owner_email , teams , origin , industry , app_type , deployment_method , web_application , archer_app_name , tags , next_day_scheduling_enabled |
Static, Dynamic | POST /appsec/v1/applications |
createbuild.do |
Creates a build of an existing application. | app_id , version |
platform , lifecycle_stage , launch_date , sandbox_id , legacy_scan_engine |
Static, Dynamic | |
deleteapp.do |
Deletes an existing application from the portfolio. | app_id |
Static, Dynamic | DELETE /appsec/v1/applications/{applicationGuid} |
|
deletebuild.do |
Deletes the most recent build of an application. | app_id |
sandbox_id |
Static, Dynamic | |
getappinfo.do |
Returns all the application profile information. | app_id |
Static, Dynamic | GET /appsec/v1/applications/{applicationGuid} |
|
getapplist.do |
Compiles a list of applications in the portfolio. | include_user_info |
Static, Dynamic | GET /appsec/v1/applications |
|
getbuildinfo.do |
Returns all the information about the build. | app_id |
build_id , sandbox_id |
Static, Dynamic | |
getbuildlist.do |
Compiles a list of all the builds of an application. | app_id |
sandbox_id |
Static, Dynamic | |
getfilelist.do |
Compiles a list of the uploaded files in an application. | app_id |
build_id , sandbox_id |
Static | |
getpolicylist.do |
Compiles a list of the policies available for use by your account. | Static, Dynamic | GET /appsec/v1/policies |
||
getprescanresults.do |
Fetches the results of the prescan. | app_id |
build_id , sandbox_id |
Static | |
getvendorlist.do |
Compiles a list of third-party vendors provisioned for scans. | Static, Dynamic | |||
removefile.do |
Removes specified files of an application. | app_id , file_id |
sandbox_id |
Static | |
updateapp.do |
Amends an existing application in the portfolio. | app_id |
app_name , description , policy , business_criticality , business_unit , business_owner , business_owner_email , teams , origin , industry , app_type , deployment_method , archer_app_name , tags , custom_field_name , custom_field_value , next_day_scheduling_enabled |
Static, Dynamic | PUT /appsec/v1/applications/{applicationGuid} |
updatebuild.do |
Updates the most recent build of an application. | app_id |
build_id , version , lifecycle_stage , launch_date , sandbox_id |
Static, Dynamic | |
uploadfile.do |
Uploads the files of an application. | app_id , file |
sandbox_id , save_as |
Static | |
uploadlargefile.do |
Uploads the files of an application as a set of parts to avoid timeout errors during the upload. | app_id , file |
filename , sandbox_id |
Static |