getvsalist.do

APIs

The getvsalist.do call returns a list of available 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 API role to use this call.

Parameters

This call takes no parameters.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/getvsalist.do

Results

The getvsalist.do call returns the vsalist XML document, which references the vsalist.xsd. Additional vsalist.xsd schema documentation is available. The returned information includes the status of each available VSA. These statuses include:
  • notvsa: The scan engine is not a virtual scan appliance.
  • 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 job.

Use the XSD file to validate the XML data. The following is an example of the returned XML.

<?xml version="1.0" encoding="UTF-8"?><vsalist
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns="https://analysiscenter.veracode.com/schema/4.0/vsalist"
          xsi:schemaLocation="https://analysiscenter.veracode.com/schema/4.0/vsalist
          https://analysiscenter.veracode.com/resource/4.0/vsalist.xsd"
          account_id="11111"><appliance vsa_id="12345" vsg_id="2222" vsa_status="uninitialized"
          vsa_status_desc="The VSA has not been initialized." vsa_name="Test Vsa 1" vsa_desc="Test
          Desc 1"/><appliance vsa_id="12346" vsg_id="2223" vsa_status="operational"
          vsa_status_desc="The VSA is configured and ready to accept jobs." vsa_name="Test Vsa 2"
          vsa_desc="Test Desc 2"/></vsalist>