generatearcherreport.do

GRCs

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

The following 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.

app_id Integer. The application 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_list String. A comma-separated list (no spaces permitted) of the 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.
period Use a time period: yesterday, last_week (preceding Saturday to Sunday), last_month (preceding calendar month). Using the period option selects any published applications that have had modifications (either published or mitigated) during the specified time period.
from_date String. Specify the beginning of a date range using a MM-dd-yyyy format. The range begins at 12:00AM ET on the specified date. This parameter defaults to the earliest possible date. You can use this parameter with the to_date parameter, but it is not required to use both.
to_date String. Specify the end of a date range using MM-dd-yyyy format. The range ends at 12:00AM ET the morning after the specified date. The default is the current day. You can use this parameter with the from_date parameter, but it is not required to use both.
scan_type Specify one of the following flaw types: static, dynamic, manual.

Example

curl --compressed -u [username] https://analysiscenter.veracode.com/api/3.0/generatearcherreport.do > archer.xml

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 archerreport.xsd. Use the XSD file to validate the XML data.