Skip to main content

generatearcherreport.do

The generatearcherreport.do call initiates the process of generating the Archer report, which contains a token you use to retrieve the report when the processing is complete.

Resource URL​

https://analysiscenter.veracode.com/api/3.0/generatearcherreport.do

Parameters​

These parameters are optional. However, to avoid returning an oversized report and risking the failures that an unwieldy report can cause, Veracode recommends that you only select the minimum number of parameters necessary for your report.

For example, limit the time window when using from_date and to_date as much as possible and limit the number of IDs added to app_id_list to make the report creation time faster and the final report size manageable.

NameTypeDescription
app_idIntegerApplication ID of the application for which you wish to pull data. You can find the application ID in the main Archer feed or by using the Results API. In a single call, you cannot use this parameter if you are also using the app_id_list parameter.
app_id_listStringComma-separated list, with no spaces, of application IDs for which you want to pull data. You can find the application IDs in the main Archer feed or by using the Results API. In a single call, you cannot use this parameter if you are also using the app_id parameter.
periodStringUse to select published applications with modifications, either published or mitigated, during the specified time period: yesterday, last week (preceding Saturday to Sunday), last month (preceding calendar month)
from_dateStringSpecify the beginning of a date range using a MM-dd-yyyy format. The range begins at 12:00AM ET on the specified date. You can use this parameter with the to_date parameter, but it is not required to use both. The default is the earliest possible date.
to_dateStringSpecify the end of a date range using MM-dd-yyyy format. The range ends at 12:00AM ET the morning after the specified date. You can use this parameter with the from_date parameter, but it is not required to use both. Default is the current day.
scan_typeStringSpecify a scan type: static, dynamic, manual

HTTPie example​

Examples use the HTTPie command-line tool.

http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/3.0/generatearcherreport.do"

HTTPie results​

The generatearcherreport.do call returns the token string you need to retrieve the report using the downloadarcherreport.do call. Each user account can only use the five most recently produced tokens to download an Archer report, which means that if you generated 10 reports, you can only use the tokens from the last five reports. All tokens expire after 30 days.

The generatearcherreport.do call references the archerreportrequest.xsd schema file. You can use the XSD schema file to validate the XML data.

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

<archerreport 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;1.0&#x2f;archerapi"
  xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com
  &#x2f;schema&#x2f;1.0&#x2f;archerapi
  https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;
  1.0&#x2f;archerreportrequest.xsd" token="<report token>" archer_report_version="3.0">
</archerreport>
Last updated on