Randori API

Edit online

The Randori API is bidirectional. Any actions that can be taken with the web UI can also be accomplished by using the API.

IBM Security® Randori provides a bidirectional API based on the OpenAPI 3.0 specification and supports API client generation in many languages, such as Python, Ruby, Go, Curl, and PHP.

From the main navigation menu, click Randori Settings > API to open your API settings page, and then click the Randori API link to download the current API specification.

Tip: When you download the OpenAPI specification, you receive a .json file that contains the available endpoints based on the user permissions. Alternatively, if you use your API key to curl to the OpenAPI link, you receive a .json file that contains the available endpoints based on the permissions of the API key that you generated.

After you download and decompress the Randori_API.zip file, open the Randori API Getting Started Guide.pdf document to learn how to access, authenticate, and interact with the Randori API. The guide includes information about generating a Randori API key and using the Python API software development kit (SDK). It also includes a common_functions library and examples for creating your first scripts with the SDK.

To understand how numeric values are received from the API and map to the high, medium, and low scores in the Randori UI, refer to the Priority and Temptation documentation.