getapplist.do

APIs

The getapplist.do call compiles a list of the applications in the portfolio. If you use the optional parameter to include user information, this call also returns details about tasks for which you have permissions to perform on the application, such as view scan results and approve mitigations for this application.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Resource URL

https://analysiscenter.veracode.com/api/5.0/getapplist.do

Parameters

include_user_info Boolean. Optional.

cURL Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/getapplist.do -F
          "include_user_info=true"

cURL Results

The getapplist.do call returns the applist XML document, which references the applist.xsd. Additional applist.xsd schema documentation is available. Use the XSD file to validate the XML data. The following is an example of the returned XML:
<applist xsi:schemaLocation="https://analysiscenter.veracode.com/schema/2.0/applist https://analysiscenter.veracode.com/resource/2.0/applist.xsd" applist_version="1.2" account_id="123">
	<app app_id="123" app_name="My Best Code" policy_updated_date="2013-11-11T14:37:34-05:00"/>
<user login_account_type="user" username="test" create_application_profile="true" create_sandbox="true" create_new_build="true" assign_app_to_team="true" assign_app_to_any_team="true" view_sandbox="true" view_results="true" approve_mitigations="true" submit_static_scan="true"/>
</applist>

Java Examples

This example uses the Veracode API ID and key credentials:

java -jar vosp-api-wrappers-java-<version #>.jar -vid <VeracodeApiId> -vkey
          <VeracodeApiKey> -action getapplist

This example uses the Veracode username and password.

java -jar vosp-api-wrappers-java-<version #>.jar -vuser <VeracodeUsername>
          -vpassword <VeracodePassword> -action getapplist

Java Results

The getapplist.do call returns the applist XML document, which references the applist.xsd. The following is an example of the returned XML:

<applist xmlns="https://analysiscenter.veracode.com/schema/2.0/applist" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" account_id="12345" applist_version="1.2" xsi:schemaLocation="https://analy
siscenter.veracode.com/schema/2.0/applist https://analysiscenter.veracode.com/resource/2.0/applist.xsd">
   <app app_id="378247" app_name="VeraDemo" policy_updated_date="2017-11-16T13:55:05-05:00"/>
   <app app_id="202545" app_name="MyApp" policy_updated_date="2018-08-17T02:24:25-04:00"/>
   <app app_id="378357" app_name="MyAppSandbox"/>
</applist>