rapid7_api_key: Get or set RAPID7_OPENDATA_API_KEY value

In ropendata: Query and Download 'Rapid7' 'Cybersecurity' Data Sets

Description

The API wrapper functions in this package all rely on a Rapid7 Open Data PI key residing in the environment variable RAPID7_OPENDATA_API_KEY. The easiest way to accomplish this is to set it in the '.Renviron' file in your home directory.

Usage

rapid7_api_key(force = FALSE)

Arguments

force

Force setting a new Rapid7 Open Data API key for the current environment?

Details

API requests are authenticated by a key which can be found and managed from your user profile. With every call to the API, the user must be authenticated. The API has a simple means to do this by passing in your key as an HTTP “Authorization” header with the request.

When you signed up for Rapid7 Open Data, a ‘default-key’ was generated for your convenience. This is the key that is used throughout the example code within algorithm pages. For these examples to work correctly, this default key must exist with all the permissions, otherwise the usage examples may result in a 401 Unauthorized error.

You need a Rapid7 account to get an API key. You can request a free account via <https://opendata.rapid7.com/#register> and then navigate to the "Open Data API" link there to create both an organizational key and a user key. You can only use **user keys** with the Open Data API and you will receive error messages indicating so if you try to use an organizational key.

Value

atomic character vector containing the Rapid7 Open Data API key

Note

As the API documentation says, you need a **User** key vs an **Org** key.

References

https://opendata.rapid7.com/apihelp/

ropendata documentation built on May 2, 2019, 11:31 a.m.