dynamicincludeexclude.do

APIs

The dynamicincludeexclude.do call configures a DynamicDS scan request to include and exclude specified URLs.

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

Resource URL

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

Permissions

You need the Upload API role to use this call.

Parameters

app_id Integer. Required.
url String. Required.
is_exclude String. true or false. Optional. Default is false.
https_http_inclusion String. true or false. Optional. Default is false.
directory_restriction_policy String. Values include:
  • dir_only
  • dir_and_sub
  • no_restrict
  • file
Optional.
  • To include the entire website, the default value is no_restrict.
  • To exclude a directory path (when the last character of the parameter value is a slash), the default value is dir_only.
  • To exclude a filepath (not providing the slash after the filename), the default value is file.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/dynamicincludeexclude.do -F "app_id=10886" -F
          "url=http://www.veracode.com/contact-us" -F " is_exclude=true" -F "
          https_http_inclusion=true" -F " directory_restriction_policy=file" 

Results

The dynamicincludeexclude.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="701"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><exclude_urls><exclude_url
          host="http://www.veracode.com/contact-us" directory_restriction_policy="file"
          https_http_inclusion="true"/></exclude_urls></dynamic_scan></dynamic_scan_info>