get_file_details {ropendata}

Retrieve details for a given file from a specific Rapid7 Open Data study

Description

Retrieve details for a given file from a specific Rapid7 Open Data study

Usage

get_file_details(study_name, file_name, include_download_link = FALSE,
  rapid7_opendata_api_key = rapid7_api_key())

Arguments

study_name

A valid study name. This should be a value from the field uniqid in the result from a call to list_studies(). Current known, good values are "sonar.national_exposure", "heisenberg.cowrie", "sonar.atg_10001_tcp", "sonar.http", "sonar.ssl", "sonar.tcp", "sonar.moressl", "sonar.rdns_v2", "sonar.udp", "sonar.cio", "sonar.https", "sonar.fdns", "sonar.rdns", and "sonar.fdns_v2".

file_name

A valid file name from a given study_name.

include_download_link

if TRUE, have the API generate a download link along with the metadata and include it in a url field in the data frame. NOTE that each use of the this parameter counts towards the Rapid7 Open Data daily download quota. For that reason, the default value is FALSE. Only set it to TRUE if you intend to start a download action (e.g. using utils::download.file() with the result) shortly after calling the function.

rapid7_opendata_api_key

Your Rapid7 Open Data API key. The various API interface function look for this key in RAPID7_OPENDATA_API_KEY. You can manually provide this key and if the function is used interactively and the key is not found, you will be prompted to enter the key.

Value

data frame

Examples

try(
  get_file_details("sonar.fdns_v2", "2018-06-15-1529049662-fdns_aaaa.json.gz"),
  silent=TRUE
) -> details