Upload XML APIs quick reference
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 | XML API Parameters | Scan Type |
|---|---|---|---|
beginprescan.do | Initiates the prescan of an application. | app_idOptional: sandbox_idauto_scanscan_all_nonfatal_top_level_modules | Static |
beginscan.do | Initiates the full scan of an application. | app_id and one of these parameters: modulesscan_all_top_level_modulesscan_previously_selected_modulesscan_selected_modulesOptional: sandbox_id | Static |
createapp.do | Creates a new application in the portfolio. | app_namebusiness_criticalityOptional: descriptionvendor_idpolicybusiness_unitbusiness_ownerbusiness_owner_emailteamsoriginindustryapp_typedeployment_methodweb_applicationarcher_app_nametagsnext_day_scheduling_enabled | Static, Dynamic |
createbuild.doREST equivalent: POST /appsec/v1/applications | Creates a build of an existing application. | app_idversionOptional: platformlifecycle_stagelaunch_datesandbox_idlegacy_scan_engine | Static, Dynamic |
deleteapp.doREST equivalent: DELETE /appsec/v1/applications/{applicationGuid} | Deletes an existing application from the portfolio. | app_id | Static, Dynamic |
deletebuild.do | Deletes the most recent build of an application. | app_id Optional: sandbox_id | Static, Dynamic |
getappinfo.doREST equivalent: GET /appsec/v1/applications/{applicationGuid} | Returns all the application profile information. | app_id | Static, Dynamic |
getapplist.doREST equivalent: GET /appsec/v1/applications | Compiles a list of applications in the portfolio. | Optional: include_user_info | Static Dynamic |
getbuildinfo.do | Returns all the information about the build. | app_idOptional: build_idsandbox_id | Static, Dynamic |
getbuildlist.do | Compiles a list of all the builds of an application. | app_idOptional: sandbox_id | Static, Dynamic |
getfilelist.do | Compiles a list of the uploaded files in an application. | app_idOptional: build_idsandbox_id | Static |
getpolicylist.doREST equivalent: GET /appsec/v1/policies | Compiles a list of the policies available for use by your account. | Static, Dynamic | |
getprescanresults.do | Fetches the results of the prescan. | app_idOptional: build_idsandbox_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_idfile_idOptional: sandbox_id | Static |
updateapp.doREST equivalent: PUT /appsec/v1/applications/{applicationGuid} | Amends an existing application in the portfolio. | app_idOptional: app_namedescriptionpolicybusiness_criticalitybusiness_unitbusiness_ownerbusiness_owner_emailteamsoriginindustryapp_typedeployment_methodarcher_app_nametagscustom_field_namecustom_field_valuenext_day_scheduling_enabled | Static, Dynamic |
updatebuild.do | Updates the most recent build of an application. | app_idOptional: build_idversionlifecycle_stagelaunch_datesandbox_id | Static, Dynamic |
uploadfile.do | Uploads the files of an application. | app_idfileOptional: sandbox_idsave_as | Static |
uploadlargefile.do | Uploads the files of an application as a set of parts to avoid timeout errors during the upload. | app_idfileOptional: filenamesandbox_id | Static |