createdynamicscan.do

Veracode 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.

After calling createdynamicscan.do, call the scan configuration APIs as needed:

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&#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;dynamicscaninfo" 
         xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;dynamicscaninfo 
         https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;4.0&#x2f;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>