uploadformbasedloginscript.do

APIs

The uploadformbasedloginscript.do call enables you to upload a forms-based login script for a DynamicDS scan.

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

Resource URL

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

Permissions

You need the Upload API or Upload API - Submit Only role to use this call.

Parameters

app_id Integer. Required.
login_script File. Required.
verification_url String. Required.
verification_text String. Required

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/uploadformbasedloginscript.do -F
          "app_id=10256" -F "login_script=@dvwa_login.html" -F
          "verification_url=http://vospfodder11/index.php" -F
        "verification_text=Welcome"

Results

The uploadformbasedloginscript.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" 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>
 <login> <script_based_login login_sequence="dvwa_login.html" verify_url="http://vospfodder11/csrf/index.php" verify_string="Welcome"/>
 </login>
 </dynamic_scan>
 </dynamic_scan_info>