dynamicscanconfig.do

APIs

The dynamicscanconfig.do call configures 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/dynamicscanconfig.do

Permissions

You need the Upload API role to use this call.

Parameters

app_id Integer. Required.
target_url String. Required.
last_name String. Required.
first_name String. Required.
phone String. Required.
email String. Required.
https_http_inclusion String. true or false. Optional. Default is false.
directory_restriction_policy String. dir_only or dir_and_sub. Optional. Default is no_restrict.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/dynamicscanconfig.do -F "app_id=10886" -F
          "target_url=http://www.veracode.com" -F " last_name=Smith" -F " first_name=John" -F "
          phone=123-456-7890" -F " email=jsmith@domain.com" -F " https_http_inclusion=true" -F "
          directory_restriction_policy=dir_and_sub"

Results

The dynamicscanconfig.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 the 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="12345" scan_name="Test Dynamic" scan_status="Incomplete" target_url="http://www.veracode.com" directory_restriction_policy="true" https_http_inclusion="true">
        <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>
        </dynamic_scan>
        </dynamic_scan_info>