Skip to main content

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.

We recommend using the REST APIs. For new integrations, always use the REST APIs.

XML API callDescriptionXML API parametersScan type
beginprescan.doInitiates the prescan of an application.app_id

Optional:
sandbox_id
auto_scan
scan_all_nonfatal_top_level_modules
Static
beginscan.doInitiates 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

Optional:
sandbox_id
Static
createapp.do

REST equivalent:
POST /appsec/v1/applications
Creates a new application in the portfolio.app_name
business_criticality

Optional:
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
createbuild.do
Creates a build of an existing application.app_id
version

Optional:
platform
lifecycle_stage
launch_date
sandbox_id
legacy_scan_engine
Static,
Dynamic
deleteapp.do

REST equivalent:
DELETE /appsec/v1/applications/{applicationGuid}
Deletes an existing application from the portfolio.app_idStatic,
Dynamic
deletebuild.doDeletes the most recent build of an application.app_id

Optional:
sandbox_id
Static,
Dynamic
getappinfo.do

REST equivalent:
GET /appsec/v1/applications/{applicationGuid}
Returns all the application profile information.app_idStatic,
Dynamic
getapplist.do

REST equivalent:
GET /appsec/v1/applications
Compiles a list of applications in the portfolio.

Optional:
include_user_info
Static
Dynamic
getbuildinfo.doReturns all the information about the build.app_id

Optional:
build_id
sandbox_id
Static,
Dynamic
getbuildlist.doCompiles a list of all the builds of an application.app_id

Optional:
sandbox_id
Static,
Dynamic
getfilelist.doCompiles a list of the uploaded files in an application.app_id

Optional:
build_id
sandbox_id
Static
getpolicylist.do

REST equivalent:
GET /appsec/v1/policies
Compiles a list of the policies available for use by your account.Static,
Dynamic
getprescanresults.doFetches the results of the prescan.app_id

Optional:
build_id
sandbox_id
Static
getvendorlist.doCompiles a list of third-party vendors provisioned for scans.Static,
Dynamic
removefile.doRemoves specified files of an application.app_id
file_id

Optional:
sandbox_id
Static
updateapp.do

REST equivalent:
PUT /appsec/v1/applications/{applicationGuid}
Amends an existing application in the portfolio.app_id

Optional:
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
updatebuild.doUpdates the most recent build of an application.app_id

Optional:
build_id
version
lifecycle_stage
launch_date
sandbox_id
Static,
Dynamic
uploadfile.doUploads the files of an application.app_id
file

Optional:
sandbox_id
save_as
Static
uploadlargefile.doUploads the files of an application as a set of parts to avoid timeout errors during the upload.app_id
file

Optional:
filename
sandbox_id
Static