getpolicylist.do

Veracode APIs

The getpolicylist.do call compiles a list of policies available to your account.

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

Resource URL

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

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/getpolicylist.do"

HTTPie Results

The getpolicylist.do call returns the list XML document, which references the policylist.xsd schema file. You can use the XSD schema file to validate the XML data.
<?xml version="1.0" encoding="UTF-8"?>

<policylist 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;policylist" 
      xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;policylist 
      https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;4.0&#x2f;policylist.xsd" 
      account_id="<account id>">
   <policies names="Veracode Recommended Very High,Veracode Recommended High,Veracode Recommended Medium,
      Veracode Recommended Low,Veracode Recommended Very Low,Veracode Recommended Mobile Policy,
      Veracode Recommended Very High &#x2b; SCA,Veracode Recommended High &#x2b; SCA,Veracode Recommended Medium &#x2b; 
      SCA,Veracode Transitional Very High,Veracode Transitional High,Veracode Transitional Medium,Veracode Transitional Low,
      Veracode Transitional Very Low,PCI 3.2.1"/>
</policylist>

Java Example

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

Java Results

The getpolicylist.do call returns the list XML document, which references the policylist.xsd schema file. You can use the XSD schema file to validate the XML data.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<policylist xmlns="https://analysiscenter.veracode.com/schema/4.0/policylist" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      account_id="<account_id> 
      xsi:schemaLocation="https://analysiscenter.veracode.com/schema/4.0/policylist 
      https://analysiscenter.veracode.com/resource/4.0/policylist.xsd">
   <policies names="Veracode Recommended Very High,Veracode Recommended High,Veracode Recommended Medium,
      Veracode Recommended Low, Veracode Recommended Very Low,Veracode Recommended Mobile Policy,
      Veracode Recommended Very High + SCA,Veracode Recommended High + SCA,Veracode Recommended Medium + SCA,
      Veracode Transitional Very High,Veracode Transitional High,Veracode Transitional Medium,
      Veracode Transitional Low,Veracode Transitional Very Low,PCI 3.2"/>   
</policylist>