This table lists the XML API calls and their parameters. It also provides links to the equivalent REST API calls, if available. Veracode recommends that you use the REST APIs. You can print this topic for future reference.
| XML API Call | XML API Location | Required Parameters | Optional Parameters | Scan Type | Equivalent REST API Call |
|---|---|---|---|---|---|
| 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 these parameters: modules, scan_all_top_level_modules, scan_previously_selected_modules, scan_selected_modules | 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 | POST /appsec/v1/applications |
| 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 | DELETE /appsec/v1/applications/{applicationGuid} | |
| 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 | GET /appsec/v1/applications/{applicationGuid} | |
| getapplist.do | https://analysiscenter.veracode.com/api/5.0/getapplist.do | include_user_info | Static, Dynamic | GET /appsec/v1/applications | |
| 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 | GET /appsec/v1/policies | ||
| 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 | PUT /appsec/v1/applications/{applicationGuid} |
| 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 | GET /appsec/v1/applications/{applicationGuid}/findings | |
| 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 | GET /appsec/v1/custom_fields | ||
| getappbuilds.do | https://analysiscenter.veracode.com/api/4.0/getappbuilds.do | only_latest, report_changed_since | Static, Dynamic, Manual | GET /appsec/v1/applications with the Findings API | |
| getcallstacks.do | https://analysiscenter.veracode.com/api/5.0/getcallstacks.do | build_id, flaw_id | Static | GET /appsec/v1/applications/{app_guid}/findings/{finding_id}/static_flaw_info | |
| summaryreport.do | https://analysiscenter.veracode.com/api/4.0/summaryreport.do | build_id | Static, Dynamic, Manual | GET /appsec/v2/applications/{app_guid}/summary_report | |
| 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 | — | POST /api/authn/v2/teams |
| 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 | — | POST /api/authn/v2/users |
| deleteteam.do | https://analysiscenter.veracode.com/api/3.0/deleteteam.do | team_id | — | DELETE /api/authn/v2/teams/{teamId} | |
| deleteuser.do | https://analysiscenter.veracode.com/api/3.0/deleteuser.do | username | custom_id | — | DELETE /api/authn/v2/users/{userId} |
| getcurriculumlist.do | https://analysiscenter.veracode.com/api/3.0/getcurriculumlist.do | — | |||
| getmaintenancescheduleinfo.do | https://analysiscenter.veracode.com/api/3.0/getmaintenancescheduleinfo.do | — | GET https://api.status.veracode.com/status | ||
| getteamlist.do | https://analysiscenter.veracode.com/api/3.0/getteamlist.do | — | GET /api/authn/v2/teams | ||
| getteaminfo.do | https://analysiscenter.veracode.com/api/3.0/getteaminfo.do | team_id | include_users, include_applications | — | GET /api/authn/v2/teams/{teamId} |
| 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 | — | GET /api/authn/v2/users/{userId} |
| 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 | — | GET /api/authn/v2/users | |
| updateteam.do | https://analysiscenter.veracode.com/api/3.0/updateteam.do | team_id | members, team_name | — | PUT /api/authn/v2/teams/{teamId} |
| 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 | — | PUT /api/authn/v2/users/{userId} |
| Mitigation API Calls | |||||
| getmitigationinfo.do | https://analysiscenter.veracode.com/api/getmitigationinfo.do | build_id, flaw_id_list | Static | GET /appsec/v2/applications/{application_guid}/findings?include_annot=true | |
| updatemitigationinfo.do | https://analysiscenter.veracode.com/api/updatemitigationinfo.do | build_id, action, comment, flaw_id_list | Static | POST /appsec/v2/applications/{application_guid}/annotations | |
| 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 | ||
| getdynamicflaws.do | https://analysiscenter.veracode.com/api/5.0/getdynamicflaws.do | build_id, flaw_id | Dynamic | GET /appsec/v1/applications/{application_guid}/findings/{finding_id}/dynamic_flaw_info | |
| uploadformbasedloginscript.do | https://analysiscenter.veracode.com/api/5.0/uploadformbasedloginscript.do | app_id, login_script, verification_url, verification_script | 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 | — | POST /appsec/v1/applications/{applicationGuid}/sandboxes |
| getsandboxlist.do | https://analysiscenter.veracode.com/api/5.0/getsandboxlist.do | app_id | — | GET /appsec/v1/applications/{applicationGuid}/sandboxes | |
| promotesandbox.do | https://analysiscenter.veracode.com/api/4.0/promotesandbox.do | build_id | — | POST /appsec/v1/applications/{applicationGuid}/sandboxes/{sandboxGuid}/promote | |
| updatesandbox.do | https://analysiscenter.veracode.com/api/4.0/updatesandbox.do | sandbox_id, custom_field_name, custom_field_value | auto_recreate | — | PUT /appsec/v1/applications/{applicationGuid}/sandboxes/{sandboxGuid} |
| deletesandbox.do | https://analysiscenter.veracode.com/api/5.0/deletesandbox.do | sandbox_id | — | DELETE /appsec/v1/applications/{applicationGuid}/sandboxes/{sandboxGuid} | |
| 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 | — | |