API Documentation | Regulus

API Documentation

Understanding Your API Key

To interact with the Regulus API, you need a unique API key, which authorizes your requests and links them to your account. Keep this key secure, as it grants access to your account's resources. Note that admin privileges are required to generate and access the key.

How to Get Your API Key

  1. Log in to your Regulus account.
  2. Navigate to the Organization Settings page.
  3. Locate the API Key section.
  4. Click the Generate API Key button to create a new key.
  5. Copy the key and store it securely. Avoid sharing it publicly.
Note: Your API key is a sensitive credential. Treat it like a password to ensure your account remains secure.

Example Organization API Key:

fff5cd6c-8aec-4c07-991d-c56cea676a37

Use your API key in the Authorization header of your requests:

curl -X GET https://api.regulus.co/v1/resource \\ -H "Authorization: Bearer YOUR_API_KEY"

References

  • Auth API - Learn how to configure and use token-based authentication.
  • Alerts API - Manage and configure alerts for transaction monitoring.
  • Audit API - Explore audit system logs.
  • Organizations API - Manage organizations and teams in your Regulus workspace.
  • Rules API - Define and manage monitoring rules for transactions.
  • Transactions API - Access and analyze your transaction data.