Reference

Reference

Welcome to the RunReveal Reference section. This area contains technical reference documentation for developers and advanced users working with RunReveal’s APIs, CLI, and other technical components.

API Reference

Logs API

Comprehensive documentation for the RunReveal Logs API, which allows you to programmatically access and query your log data.

  • Authentication and authorization
  • Endpoint details and query parameters
  • Response formats and pagination
  • Error handling and rate limits
  • Code examples in multiple languages

Tools and Utilities

Using the CLI

Learn how to use the RunReveal Command Line Interface (CLI) for automation and integration with your existing workflows.

  • Installation and configuration
  • Available commands and options
  • Authentication setup
  • Query execution and data export
  • Scripting and automation examples

Access Control

Role-Based Access Control

Detailed information about RunReveal’s role-based access control system.

  • Available roles and permissions
  • Managing user access
  • Custom role creation
  • Best practices for secure access management
  • Audit logging and compliance

Protocols

Model Context Protocol

Documentation for the Model Context Protocol used by RunReveal for advanced analysis and detection capabilities.

  • Protocol specification
  • Integration points
  • Model capabilities and limitations
  • Implementation examples

Need More Information?

If you can’t find what you’re looking for in our reference documentation, please contact our support team through:

Jupyter NotebooksLogs API