getvsalist.do

Veracode APIs

The getvsalist.do call returns a list of available Virtual Scan Appliances (VSAs).

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

Resource URL

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

Permissions

You need the Upload and Scan API role to use this call.

Parameters

This call takes no parameters.

HTTPie Example

Examples use the HTTPie command-line tool. See Using HTTPie with the Python Authentication Library.

http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/5.0/getvsalist.do"

HTTPie Results

The getvsalist.do call returns the vsalist XML document, which references the vsalist.xsd schema file. You can use the XSD schema file to validate the XML data. See the vsalist.xsd schema documentation.

The returned information includes the status of each available VSA. These statuses include:
  • notvsa: the scan engine is not a VSA.
  • alpha: the Veracode Platform cannot schedule jobs on this VSA.
  • uninitialized: the VSA is not initialized.
  • operational: the VSA is configured and ready to accept jobs.
<?xml version="1.0" encoding="UTF-8"?>

<vsalist xmlns:xsi="http&#x3a;&#x2f;&#x2f;www.w3.org&#x2f;2001&#x2f;XMLSchema-instance" 
         xmlns="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;vsalist" 
         xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;vsalist 
         https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;4.0&#x2f;vsalist.xsd" account_id="31755">
   <appliance vsa_id="<vsa id>" vsg_id="<vsg id>" vsa_status="uninitialized" vsa_status_desc="The VSA has not been initialized." 
      vsa_name="Vsa 1" vsa_desc="Test Desc 1"/>
   <appliance vsa_id="<vsa id>" vsg_id="<vsg id>" vsa_status="operational" vsa_status_desc="The VSA is configured and ready to accept jobs." 
      vsa_name="Vsa 2" vsa_desc="Test Desc 2"/>   
</vsalist>