This table lists the Veracode XML API calls and their parameters. More detailed information is available in the Help Center.
| XML API Call | Location | Required Parameters | Optional Parameters | Scan Type |
|---|---|---|---|---|
| Upload API Calls | ||||
| beginprescan.do |
https://analysiscenter.veracode.com/api/5.0/beginprescan.do |
app_id | sandbox_id, auto_scan, scan_all_nonfatal_top_level_modules |
Static |
| beginscan.do | https://analysiscenter.veracode.com/api/5.0/beginscan.do | app_id and one of the following:
|
sandbox_id | Static |
| createapp.do | https://analysiscenter.veracode.com/api/5.0/createapp.do | 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 |
| createbuild.do | https://analysiscenter.veracode.com/api/5.0/createbuild.do | app_id, version | platform, lifecycle_stage, launch_date, sandbox_id, legacy_scan_engine | Static, Dynamic |
| deleteapp.do | https://analysiscenter.veracode.com/api/5.0/deleteapp.do | app_id | Static, Dynamic | |
| deletebuild.do | https://analysiscenter.veracode.com/api/5.0/deletebuild.do | app_id | sandbox_id | Static, Dynamic |
| getappinfo.do | https://analysiscenter.veracode.com/api/5.0/getappinfo.do | app_id | Static, Dynamic | |
| getapplist.do | https://analysiscenter.veracode.com/api/5.0/getapplist.do | include_user_info | Static, Dynamic | |
| getbuildinfo.do | https://analysiscenter.veracode.com/api/5.0/getbuildinfo.do | app_id | build_id, sandbox_id | Static, Dynamic |
| getbuildlist.do | https://analysiscenter.veracode.com/api/5.0/getbuildlist.do | app_id | sandbox_id | Static, Dynamic |
| getfilelist.do | https://analysiscenter.veracode.com/api/5.0/getfilelist.do | app_id | build_id, sandbox_id | Static |
| getpolicylist.do | https://analysiscenter.veracode.com/api/5.0/getpolicylist.do | Static, Dynamic | ||
| getprescanresults.do | https://analysiscenter.veracode.com/api/5.0/getprescanresults.do | app_id | build_id, sandbox_id | Static |
| getvendorlist.do | https://analysiscenter.veracode.com/api/5.0/getvendorlist.do | Static, Dynamic | ||
| removefile.do | https://analysiscenter.veracode.com/api/5.0/removefile.do | app_id, file_id | sandbox_id | Static |
| updateapp.do | https://analysiscenter.veracode.com/api/5.0/updateapp.do | 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 |
| updatebuild.do | https://analysiscenter.veracode.com/api/5.0/updatebuild.do | app_id | build_id, version, lifecycle_stage, launch_date, sandbox_id | Static, Dynamic |
| uploadfile.do | https://analysiscenter.veracode.com/api/5.0/uploadfile.do | app_id, file | sandbox_id, save_as | Static |
| uploadlargefile.do | https://analysiscenter.veracode.com/api/5.0/uploadlargefile.do | app_id, file | filename, sandbox_id | Static |
| Results API Calls | ||||
| detailedreport.do | https://analysiscenter.veracode.com/api/5.0/detailedreport.do | build_id | Static, Dynamic, Manual | |
| detailedreportpdf.do | https://analysiscenter.veracode.com/api/4.0/detailedreportpdf.do | build_id | Static, Dynamic, Manual | |
| getaccountcustomfieldlist.do | https://analysiscenter.veracode.com/api/5.0/getaccountcustomfieldlist.do | Static, Dynamic, Manual | ||
| getappbuilds.do | https://analysiscenter.veracode.com/api/4.0/getappbuilds.do | only_latest, report_changed_since | Static, Dynamic, Manual | |
| getcallstacks.do | https://analysiscenter.veracode.com/api/5.0/getcallstacks.do | build_id, flaw_id | Static | |
| summaryreport.do | https://analysiscenter.veracode.com/api/4.0/summaryreport.do | build_id | Static, Dynamic, Manual | |
| summaryreportpdf.do | https://analysiscenter.veracode.com/api/4.0/summaryreportpdf.do | build_id | Static, Dynamic, Manual | |
| thirdpartyreportpdf.do | https://analysiscenter.veracode.com/api/4.0/thirdpartyreportpdf.do | build_id | Static, Dynamic, Manual | |
| Admin API Calls | ||||
| createteam.do | https://analysiscenter.veracode.com/api/3.0/createteam.do | team_name | members | — |
| createuser.do | https://analysiscenter.veracode.com/api/3.0/createuser.do | first_name, last_name, email_address, roles | custom_id, is_saml_user, login_enabled, phone, requires_token, teams, title | — |
| deleteteam.do | https://analysiscenter.veracode.com/api/3.0/deleteteam.do | team_id | — | |
| deleteuser.do | https://analysiscenter.veracode.com/api/3.0/deleteuser.do | username | custom_id | — |
| getcurriculumlist.do | https://analysiscenter.veracode.com/api/3.0/getcurriculumlist.do | — | ||
| getmaintenancescheduleinfo.do | https://analysiscenter.veracode.com/api/3.0/getmaintenancescheduleinfo.do | — | ||
| getteamlist.do | https://analysiscenter.veracode.com/api/3.0/getteamlist.do | — | ||
| getteaminfo.do | https://analysiscenter.veracode.com/api/3.0/getteaminfo.do | team_id | include_users, include_applications | — |
| gettracklist.do | https://analysiscenter.veracode.com/api/3.0/gettracklist.do | — | ||
| getuserinfo.do | https://analysiscenter.veracode.com/api/3.0/getuserinfo.do | username | custom_id | — |
| getuserlist.do | https://analysiscenter.veracode.com/api/3.0/getuserlist.do | first_name, last_name, custom_id, email_address, login_account_type, phone, teams, roles, is_saml_user, login_enabled, requires_token, is_elearning_manager, elearning_track, elearning_curriculum, keep_elearning_active, custom_one, custom_two, custom_three, custom_four, custom_five | — | |
| updateteam.do | https://analysiscenter.veracode.com/api/3.0/updateteam.do | team_id | members, team_name | — |
| updateuser.do | https://analysiscenter.veracode.com/api/3.0/updateuser.do | username, custom_id | first_name, last_name, email_address, login_account_type, phone, teams, roles, is_saml_user, login_enabled, requires_token, has_ip_restrictions, allowed_ip_addresses is_elearning_manager, elearning_track, elearning_curriculum, keep_elearning_active, custom_one, custom_two, custom_three, custom_four, custom_five | — |
| Mitigation API Calls | ||||
| getmitigationinfo.do | https://analysiscenter.veracode.com/api/getmitigationinfo.do | build_id, flaw_id_list | Static | |
| updatemitigationinfo.do | https://analysiscenter.veracode.com/api/updatemitigationinfo.do | build_id, action, comment, flaw_id_list | Static | |
| Archer API Calls | ||||
| archer.do | https://analysiscenter.veracode.com/api/archer.do | app_id, period, from_date, to_date, scan_type | Static, Dynamic, Manual | |
| generatearcherreport.do | https://analysiscenter.veracode.com/api/2.0/generatearcherreport.do | app_id, period, from_date, to_date, scan_type | Static, Dynamic, Manual | |
| downloadarcherreport.do | https://analysiscenter.veracode.com/api/2.0/downloadarcherreport.do | token | Static, Dynamic, Manual | |
| DynamicDS API Calls | ||||
| createdynamicscan.do |
https://analysiscenter.veracode.com/api/5.0/createdynamicscan.do |
app_id | scan_name | Dynamic |
| dynamicscanconfig.do |
https://analysiscenter.veracode.com/api/5.0/dynamicscanconfig.do |
app_id, target_url, last_name, first_name, phone, email | https_http_inclusion, directory_restriction_policy | Dynamic |
| dynamicincludeexclude.do |
https://analysiscenter.veracode.com/api/5.0/dynamicincludeexclude.do |
app_id, url | is_exclude, https_http_inclusion, directory_restriction_policy | Dynamic |
| submitdynamicscan.do |
https://analysiscenter.veracode.com/api/5.0/submitdynamicscan.do |
app_id | start_time, end_time | Dynamic |
| rescandynamicscan.do |
https://analysiscenter.veracode.com/api/5.0/rescandynamicscan.do |
app_id | flaw_only, scan_name | Dynamic |
| getdynamicflaws.do |
https://analysiscenter.veracode.com/api/5.0/getdynamicflaws.do |
build_id, flaw_id | Dynamic | |
| getdynamicstatus.do | https://analysiscenter.veracode.com/api/5.0/getdynamicstatus.do | app_id | build_id | Dynamic |
| uploadformbasedloginscript.do | https://analysiscenter.veracode.com/api/5.0/uploadformbasedloginscript.do | app_id, login_script. verification_url, verification_script | Dynamic | |
| addbrowserbasedlogin.do | https://analysiscenter.veracode.com/api/5.0/addbrowserbasedlogin.do | app_id, username, password | windows_domain | Dynamic |
| assignvsa.do |
https://analysiscenter.veracode.com/api/5.0/assignvsa.do |
app_id, vsg_id | Dynamic | |
| getvsalist.do |
https://analysiscenter.veracode.com/api/5.0/getvsalist.do |
Dynamic | ||
| Flaw Report API Calls | ||||
| generateflawreport.do |
https://analysiscenter.veracode.com/api/2.0/generateflawreport.do |
token, scan_type | — | |
| downloadflawreport.do |
https://analysiscenter.veracode.com/api/2.0/downloadflawreport.do |
app_id_list, scan_type | — | |
| Sandbox API Calls | ||||
| createsandbox.do | https://analysiscenter.veracode.com/api/5.0/createsandbox.do | app_id, sandbox_name | auto_recreate | — |
| getsandboxlist.do | https://analysiscenter.veracode.com/api/5.0/getsandboxlist.do | app_id | — | |
| promotesandbox.do | https://analysiscenter.veracode.com/api/4.0/promotesandbox.do | build_id | — | |
| updatesandbox.do | https://analysiscenter.veracode.com/api/4.0/updatesandbox.do | sandbox_id, custom_field_name,custom_field_value | auto_recreate | — |
| deletesandbox.do | https://analysiscenter.veracode.com/api/5.0/deletesandbox.do | sandbox_id | — | |
| VAST API Calls | ||||
| sharedreport.do |
https://analysiscenter.veracode.com/api/3.0/sharedreport.do |
app_id, shared_report_id | — | |
| sharedreportpdf.do |
https://analysiscenter.veracode.com/api/3.0/sharedreportpdf.do |
app_id, shared_report_id | — | |
| getsharedreportlist.do |
https://analysiscenter.veracode.com/api/3.0/getsharedreportlist.do |
app_id | — | |
| getsharedreportinfo.do |
https://analysiscenter.veracode.com/api/3.0/getsharedreportinfo.do |
app_id | shared_report_id | — |