getdynamicstatus.do

APIs

The getdynamicstatus.do call returns the status of the specified 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/getdynamicstatus.do

Permissions

You need the Upload API role to use this call.

Parameters

app_id Integer. Required.
build_id Integer.Optional.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/5.0/getdynamicstatus.do -F
        "app_id=12345"

Results

The getdynamicstatus.do call returns the scan_status_info XML document, which references the dynamicscanstatus.xsd. Additional dynamicscanstatus.xsd schema documentation is available Use the XSD file to validate the XML data. The following is an example of the returned XML.

<scan_status_info xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://analysiscenter.veracode.com/schema/4.0/dynamicscanstatus" xsi:schemaLocation="https://analysiscenter.veracode.com/schema/4.0/dynamicscanstatus
https://analysiscenter.veracode.com/resource/4.0/dynamicscanstatus.xsd"
account_id="111111" app_id="13468" scan_id="15076">
<scan_status>Results Ready</scan_status>
<start>09/06/2013 @ 2:15 PM EDT</start>
<duration>00.0:03.0:04.0</duration>
<state>Completed</state>
<request>6105</request>
<responses>6105</responses>
<bytes_sent>757.0 KB</bytes_sent>
<bytes_received>1921.0 KB</bytes_received>
<links>3</links>
<login_failures>0</login_failures>
<logins>0</logins>
<network_errors>0</network_errors>
<unreacheble_hosts>0</unreacheble_hosts>
</scan_status_info>