submitdynamicscan.do

Veracode APIs

The submitdynamicscan.do call submits a DynamicDS scan request.

Resource URL

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

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

Permissions

You need the Upload API and Upload API - Submit Only roles to use this call.

Parameters

Name Type Description
app_id

Required

Integer Application ID.
start_time String ISO 8601-compliant combined date and time. Optional, unless you specify an end_time. Submitting an end_time without a start_time generates an error. Default is submitting scan immediately.
end_time String ISO 8601-compliant combined date and time. Optional, unless you specify start_time. Submitting a start_time without an end_time generates an error. Scan length default is one day if start_time and end_time are not specified.

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/submitdynamicscan.do" "app_id==<app id>" "start_time==2019-10-01T15:30:00-05:00" "end_time==2019-10-01T16:30:00-05:00"

HTTPie Results

The submitdynamicscan.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="Submitted to Engine" 
         target_url="http&#x3a;&#x2f;&#x2f;www.example.com&#x2f;" directory_restriction_policy="true" 
         https_http_inclusion="true">
      <contact_information first_name="Joan" last_name="Smythe" telephone="123-456-7890" email="jsmythe&#x40;example.com"/>
      <allowed_hosts>
         <allowed_host host="http&#x3a;&#x2f;&#x2f;example.com&#x2f;" directory_restriction_policy="dir_and_sub" 
            https_http_inclusion="true"/>
      </allowed_hosts>
      <exclude_urls>
         <exclude_url host="http&#x3a;&#x2f;&#x2f;example.com&#x2f;archives&#x2f;" directory_restriction_policy="dir_only" 
            https_http_inclusion="true"/>
      </exclude_urls>
      <scan_schedule start_date="2019-10-01-04&#x3a;00" start_time="16&#x3a;30&#x3a;00-04&#x3a;00" end_date="2019-10-01-04&#x3a;00" 
         end_time="17&#x3a;30&#x3a;00-04&#x3a;00"/>
   </dynamic_scan>
</dynamic_scan_info>