Skip to main content

API Keys

At a glance

API keys authenticate your Ontologie integrations (n8n, Make, Zapier, scripts) securely. Each key has a name, granular permissions, and a configurable rate limit.

Before you start

  • Access to the target workspace
  • Permission to manage API keys
  • A secrets manager (or secure environment variables)

Access API keys

From the sidebar, click the API Keys icon at the top-right of the screen.

Navigation to API keys

Overview

The API Keys page shows the creation form at the top and your existing keys list below.

API keys list

Understand a key card

Each key card summarizes:

  • Key name (for example: zapier-sync, monitoring-api)
  • Masked prefix: df_XXXX******** - only the first characters are visible
  • Rate limit: allowed requests per hour (for example: 1000/h)
  • Scopes: colored badges showing active permissions

Key card detail

Create an API key

  1. In the New API Key form, enter an explicit name (service + environment, for example n8n-production).
  2. Select a permissions preset from the dropdown.
  3. Click Create key.

Creation form

Permission presets

Five presets cover common use cases:

PresetTypical usage
Read-onlyDashboards, monitoring, read exports
SynchronizationBi-directional sync (read + write)
Automationn8n/Make workflows with full data access
MCPConnection from Claude Desktop, VS Code, or another AI client
Full accessAdministration (use with caution)

Permission presets

Customize permissions

For fine-grained control, expand Customize permissions. A checkbox grid lets you enable each scope individually (nodes, relations, actions, events, etc.) in read or write mode.

Custom permissions

Least privilege principle
Assign only the scopes strictly required for each key. Avoid the Full access preset outside admin operations.

Warning: key shown only once

After creation, the full key value is shown one time only.

One-time key display

  1. Copy the key immediately with Copy key.
  2. Store it in your secrets manager or environment variables.
  3. Click I copied my key to close the modal.
Important
If you close this modal without copying the key, you cannot retrieve it later. You must create a new key.

Usage examples

The page includes copy-ready examples for common tools.

Usage examples

cURL

curl -X GET "https://api.ontologie-growthsystemes.com/api/queries/nodes" \
-H "X-API-Key: df_YOUR_KEY" \
-H "x-workspace-id: YOUR_WORKSPACE_ID"

n8n

In an n8n HTTP Request node:

  • Method: GET
  • URL: https://api.ontologie-growthsystemes.com/api/queries/nodes
  • Headers:
    • X-API-Key: your key
    • x-workspace-id: your workspace ID

Essential rules

RuleDetail
Key shown only onceCopy it before closing the modal
1 key per applicationNever share one key across multiple services
Minimum scopesGrant only required permissions
Rotate every 90 daysRenew keys on a regular cycle
Immediate revocation if compromisedAccess is cut instantly
Never store in source codeUse environment variables

Advanced security

Each key has a security panel available via the shield icon on the key card.

IP allowlist

Restrict a key to specific IP addresses (CIDR supported).

IP allowlist

Webhook alerts

Configure a webhook to be notified on suspicious usage. Enable anomaly detection for automated alerts.

Webhook alerts

Usage quotas

Monitor per-key usage in real time: daily and monthly requests, with optional custom limits.

Usage quotas

Revoke a key

To permanently delete a key:

  1. Click the trash icon on the key card.
  2. Confirm in the revocation modal.

Revocation confirmation

Irreversible action
Revocation is immediate and final. All integrations using this key stop working instantly.

Deprecation

Before revoking, you can deprecate a key. The card shows a Deprecated badge (amber style) with an automatic deactivation date (30 days).

Deprecated key

Deprecation gives teams time to migrate to a new key before final cutoff.

MCP keys

API keys are also required to connect Ontologie to AI clients via MCP (Model Context Protocol). Use the MCP preset at creation time to assign mcp.read, mcp.write, and mcp.workflow.execute scopes automatically.

Limits

LimitValue
Keys per workspace50
Default rate limit1,000 requests/hour
Burst10 requests/second
Scopes per key10 maximum
Grace period after deprecation30 days

See also