The createdynamicscan.do call creates a DynamicDS scan request.
Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.
After calling createdynamicscan.do, call the scan configuration APIs as needed:
- dynamicscanconfig.do
- dynamicincludeexclude.do
- addbrowserbasedlogin.do
- uploadformsbasedloginscript.do
Then call submitdynamicscan.do to start the scan.
Resource URL
https://analysiscenter.veracode.com/api/5.0/createdynamicscan.do
Permissions
You need the Upload and Scan API role to use this call.
Parameters
Name | Type | Description |
---|---|---|
app_id Required |
Integer | Application ID. |
scan_name | String | Unique identifier for the new scan. |
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/createdynamicscan.do" "app_id==<app id>" "scan_name==Test DynamicDS Scan"
HTTPie Results
The createdynamicscan.do call returns the dynamic_scan_info XML document, which references the dynamicscaninfo.xsd schema file. You can use the XSD schema file to validate the XML data. See the dynamicscaninfo.xsd schema documentation.
<?xml version="1.0" encoding="UTF-8"?> <dynamic_scan_info xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://analysiscenter.veracode.com/schema/4.0/dynamicscaninfo" xsi:schemaLocation="https://analysiscenter.veracode.com/schema/4.0/dynamicscaninfo https://analysiscenter.veracode.com/resource/4.0/dynamicscaninfo.xsd" account_id="<account id>" app_id="<app id>" scan_id="5097076" error_message=""> <dynamic_scan scan_id="5097076" scan_name="Test DynamicDS Scan" scan_status="Incomplete"/> </dynamic_scan_info>