submitdynamicscan.do

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

app_id Integer. Required.
start_time String. ISO 8601 compliant combined date and time. Optional, unless end_time is submitted. Submitting an end_time without a start_time generates an error. Default is: immediately.
end_time String. ISO 8601 compliant combined date and time. Optional, unless start_time is submitted. Submitting a start_time without an end_time generates an error. Default is: 1 day.

Example

curl --compressed -u VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/submitdynamicscan.do -F "app_id=10886" -F
          "start_time=2013-09-07T04:00:00-04:00" -F
        "end_time=2013-09-07T05:30:00-04:00"

Results

The submitdynamicscan.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:schemaLocati on="
          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="12345"
          scan_name="Test Dynamic" scan_status="Submitted to Engine" target_url="
          http://www.veracode.com/ " directory_restriction_policy="true" https_http_inclusion="true"
          vsg_id="5"><contact_information first_name="John" last_name="Smith"
          telephone="123-456-7890" email=" jsmith@domain.com "/><allowed_hosts><allowed_host
          host="http://www.veracode.com" directory_restriction_policy="dir_and_sub"
          https_http_inclusion="true"/></allowed_hosts><scan_schedule
          start_date="2013-09-07-04:00" start_time="04:00:00-04:00" end_date="2013-09-07-04:00"
          end_time="05:30:00-04:00"/></dynamic_scan></dynamic_scan_info>