The dynamicscanconfig.do call adds basic configuration information to an existing DynamicDS scan request created with createdynamicscan.do.
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 and Scan API role to use this call.
Parameters
Name | Type | Description |
---|---|---|
app_id Required |
Integer | Application ID. |
target_url Required |
String | URL to scan. |
last_name Required |
String | Last name of the user. |
first_name Required |
String | First name of the user. |
phone Required |
String | Contact phone number for the user. |
email Required |
String | Contact email address for the user. |
https_http_inclusion | Boolean | If true, applies the call settings to both the HTTP and HTTPS versions of the URL. If false, only applies the call settings to the supplied URL. Default is false. |
directory_restriction_policy | String | Valid values are:
|
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/dynamicscanconfig.do" "app_id==<app id>" "target_url==http://www.example.com" "last_name==Smythe" "first_name==Joan" "phone==123-456-7890" "email==jsmythe@example.com" "https_http_inclusion==true" "directory_restriction_policy==dir_and_sub"
HTTPie Results
The dynamicscanconfig.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://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="<account id>" app_id="<app id>" scan_id="5097076" error_message=""> <dynamic_scan scan_id="5097076" scan_name="Test DynamicDS Scan" scan_status="Incomplete" target_url="http://www.example.com/" directory_restriction_policy="true" https_http_inclusion="true"> <contact_information first_name="Joan" last_name="Smythe" telephone="123-456-7890" email="jsmythe@example.com"/> <allowed_hosts> <allowed_host host="http://www.example.com/" directory_restriction_policy="dir_and_sub" https_http_inclusion="true"/> </allowed_hosts> </dynamic_scan> </dynamic_scan_info>