Most actions in the Veracode Java and C# API wrappers expose required or optional parameters. Some parameters apply to every action that the wrapper supports.
Parameter | Type | Description |
---|---|---|
action Required |
String | Name of the action. |
vid | String | Veracode API ID. |
vkey | String | Veracode API key. |
credprofile | String | Name of the profile in the Veracode API credentials file to use for authentication. Note: Your command must not include both the
credprofile parameter and the vid/vkey
parameters or you see an error.
|
debug | String | Include to show detailed diagnostic information, which you can use for debugging, in the output. Exclude to not show the diagnostic information. |
inputfilepath | String | Path to a CSV file that contains the parameters to use for the command. You can use inputfilepath to make multiple calls to the API specified by the action. In the CSV file, use one row to specify the parameters for each call. For an example, see createuser.do. |
logfilepath | String | Filepath of the log file where commands save informational and error messages. |
phost | String | Proxy host. Note: Do not include the web protocol, such as HTTP or HTTPS, in the
proxy host. Including the protocol can cause an error.
|
ppassword | String | Proxy password. |
pport | String | Proxy port. |
puser | String | Proxy user. |
Examples
For example, run getapplist with these parameters to return a list of applications in the application portfolio of an account:
java -jar VeracodeJavaAPI.jar -action getapplist -vid <Veracode API ID> -vkey <Veracode API key> -phost proxyhost.com -pport 8080 -puser <proxy username> -ppassword <proxy password>
VeracodeC#API.exe -action getapplist -vid <Veracode API ID> -vkey <Veracode API key> -phost proxyhost.com -pport 8080 -puser <proxy username> -ppassword <proxy password>
Veracode recommends that you use an external Veracode API credentials file to provide your credentials to the Veracode API wrapper. When you use a Veracode API credentials file, you can omit the -vid and -vkey parameters for specifying your Veracode API credentials.
To see the required and optional parameters for an action, you can run -action and review the returned text. After reading the returned text, you know which parameters to include in your command.
For example, to return a list of required and optional parameters for createapp.do, run -action createapp.
Veracode recommends that you use an external Veracode API credentials file to provide your credentials to the Veracode API wrapper. When you use a Veracode API credentials file, you can omit the -vid and -vkey parameters for specifying your Veracode API credentials.
You replace the parameter values with your Veracode API ID, Veracode API key, application name, and the level of business criticality of the application. See the createapp.do call for more information on the parameters.
Arguments
All parameters require an argument or value. For example, the -criticality parameter requires an argument of VeryHigh, High, Medium, Low, or VeryLow. When you run -action, to see the parameters for an action, you also see the list of arguments under Usage.