createdynamicscan.do

APIs

The createdynamicscan.do call creates a DynamicDS scan request.

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

Resource URL

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

Permissions

You need the Upload API role to use this call.

Parameters

app_id Integer. Required.
scan_name String. Optional.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/createdynamicscan.do -F "app_id=10886" -F
          "scan_name=Blog Dynamic Scan"

Results

The createdynamicscan.do call returns the dynamic_scan_info XML document, which references the dynamicscaninfo.xsd. Additional dynamicscaninfo.xsd schema documentation is available. Use the XSD file to validate the XML data. The following is an example of returned XML.

<?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="11111" app_id="10886" scan_id="12345" error_message="">
        <dynamic_scan scan_id="10482" scan_name="dyn_api_test_scan_00" scan_status="Incomplete"/>
        </dynamic_scan>
        </dynamic_scan_info>
<?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="11111"
          app_id="10886" scan_id="12345" error_message=""><dynamic_scan scan_id="10482"
          scan_name="dyn_api_test_scan_00"
          scan_status="701"/></dynamic_scan></dynamic_scan_info>