getdynamicstatus.do

Veracode 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 and Scan API role to use this call.

Parameters

Name Type Description
app_id

Required

Integer Application ID.
build_id Integer Application or sandbox build ID.

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/getdynamicstatus.do" "app_id==<app id>"

HTTPie Results

The getdynamicstatus.do call returns the scan_status_info XML document, which references the dynamicscanstatus.xsd schema file. You can use the XSD schema file to validate the XML data. See the dynamicscanstatus.xsd schema documentation.

<?xml version="1.0" encoding="UTF-8"?>

<scan_status_info xmlns:xsi="http&#x3a;&#x2f;&#x2f;www.w3.org&#x2f;2001&#x2f;XMLSchema-instance" 
         xmlns="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;dynamicscanstatus" 
         xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;dynamicscanstatus 
         https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;4.0&#x2f;dynamicscanstatus.xsd" 
         account_id="<account id>" app_id="<app id>" scan_id="5097076">
   <scan_status>Scan In Process</scan_status>
   <start>10&#x2f;01&#x2f;2019 &#x40; 4&#x3a;46 PM EDT</start>
   <duration>00.0&#x3a;26.0&#x3a;21.0</duration>
   <state>In Process</state>
   <request>4000</request>
   <responses>4000</responses>
   <bytes_sent>1539.0 KB</bytes_sent>
   <bytes_received>1963.0 KB</bytes_received>
   <links>5</links>
   <login_failures>0</login_failures>
   <logins>0</logins>
   <network_errors>1</network_errors>
   <unreacheble_hosts>0</unreacheble_hosts>
</scan_status_info>