Skip to main content
API keys provide secure authentication for integrating Honeydew with external tools and services. Honeydew supports both organization-level and per-user API keys to meet different security and audit requirements.

​
Overview

API keys enable secure access to Honeydew’s API and integrations, allowing you to:
  • Connect BI tools and other services to your Honeydew instance
  • Execute queries and retrieve data programmatically
  • Maintain audit trails for compliance and security
It is recommended to restrict API keys use to specific IP addresses or ranges, by using the IP Access Control feature. To set up IP Access Control, please contact support@honeydew.ai.

​
API Key Types

​
Organization-Level API Keys

What they are: Single API keys that provide access for your entire organization Who can create: Organization administrators Access level: Organization-wide access with assigned roles Use cases:
  1. Simple integrations: When you are not required to track individual users’ access and actions
  2. Service accounts: For automated processes or system integrations
  3. Team-wide access: When multiple users share the same access level
  4. Quick setup: For initial integration testing and development

​
Per-User API Keys

What they are: Individual API keys for each user in your organization Who can create: Organization administrators or individual users (configurable) Access level: User-specific access with individual tracking. The key assumes the role of the user it is assigned to. Use cases:
  1. Individual user identification: When you need to identify which specific user made each query
  2. Per-user Snowflake credentials: Integration with OAuth or other per-user authentication
  3. Compliance requirements: Organizations needing detailed audit trails per user
  4. Granular access control: Different access levels for different users

​
Configuration Modes

Per-user API keys support two operational modes:

​
Admin-Only Mode

  • Only administrators can create API keys for users
  • Centralized control over key distribution
  • Higher security with administrative oversight

​
User Self-Service Mode

  • Users can create and manage their own API keys
  • Distributed access with individual responsibility
  • Suitable for organizations with independent user access needs

​
Setup Instructions

Contact support@honeydew.ai to enable per-user API keys for your organization.

​
Organization-Level API Keys

  1. Navigate to Settings → API Keys in the Honeydew application
  2. Select Create API Key
  3. Create a descriptive name for the API key
  4. Assign the appropriate role (Admin, Editor, or Viewer - see User Roles)
  5. Generate and securely store the API key

​
Per-User API Keys

For Admin-Only Mode:
  1. Administrators navigate to Settings → API Keys
  2. Select Create API Key
  3. Choose the user for whom the API key is being created
  4. Generate and securely distribute the API key
For User Self-Service Mode:
  1. Users navigate to Settings → API Keys
  2. Select Create API Key (per-user option available)
  3. Generate and securely store the personal API key

​
Security Best Practices

  • Key Rotation: Regularly rotate API keys
  • Principle of Least Privilege: Assign minimal necessary roles
  • Secure Storage: Store keys securely and never share them
  • Access Review: Regularly review active API keys and usage

​
Supported Integrations

Both API key types work with all Honeydew integrations that support API key authentication: For specific integration setup, refer to the individual integration documentation pages.