Rate Limit

logic.rate-limit Logic v0.1.0

Multi-tenant rate limiting: identifies the caller by a tenant GUID header, enforces per-second/minute/hour/day windows (with per-tenant overrides from Admin → Tenants), and passes or routes to Limited — or, with a ◈ Queue attached, parks over-limit requests and releases them at pace.

Finding it in the library

Search the builder's node library for Rate Limit (it lives under Logic). A single click opens the in-editor docs panel shown here — description, ports, and every property, without leaving the canvas. Double-click (or drag) to add it to the workflow.

Library capture pending — regenerate with npm run shots:nodes.

Wired up in the builder

Rate Limit in a real, runnable flow — captured live from the Studio editor, exactly as it looks on your canvas. This is the same workflow used for the example input & output below.

Canvas capture pending — regenerate with npm run shots:nodes.

How it’s configured

The node’s Configure panel as it opens in the builder when you select the step — every setting laid out with real values. Click any field to edit it.

Config capture pending — regenerate with npm run shots:nodes. See the full property reference below.

Ports

Ports are the node’s contract with its neighbours. In the editor a port label renders bold when wired and italic when optional; ports accept attachment carriers rather than data wires.

DirectionPortLabelWhat flows through it
InputinputInput
OutputoutputPass
OutputlimitedLimited

How data flows through it

Rate Limit consumes the content of the incoming envelope — when it is fed directly by a trigger, the trigger’s wrapper is unwrapped at the node boundary so the node sees the actual data, not the metadata shell. Its output becomes the payload for the next node, while the envelope (trace ids, correlation, binary refs) rides along untouched. In the Runs view you always see the whole envelope for both sides of this node.

Expressions in the config

String-typed properties accept {{ }} expressions evaluated against the incoming item at run time — e.g. {{ $json.customer.email }}. On this node that’s tenantHeader, tenants, scope, queueName, queueBroker, queueToken, storageHost, storagePassword. JSON- and code-typed fields never interpolate — they are passed through literally.

Build it with AI

Every node in this reference is reachable through Flowdrome’s AI Copilot and the MCP tools — say what you want, and the graph surgery happens server-side. Node types resolve fuzzily, so the catalog label (Rate Limit) works as well as the exact type id (logic.rate-limit).

In the Copilot panel (or any connected AI):

add a rate limit node after the trigger

As a step in a create_chain_workflow call:

{"type":"Rate Limit","config":{}}
Raw MCP call — add this node to a workflow with add_node
curl -s -X POST http://localhost:48170/mcp -H "content-type: application/json" -d '{ "jsonrpc": "2.0", "id": "1", "method": "tools/call", "params": { "name": "add_node", "arguments": { "workflowId": "<id>", "type": "Rate Limit" } } }'

Example input & output

Captured from a real test run of the workflow above — this is what you see in the run data panel after pressing Test workflow.

Input — what the node received

{
  "kind": "json",
  "contentType": "application/json",
  "payload": {
    "tenant": "smoke-tenant"
  },
  "body": {
    "tenant": "smoke-tenant"
  }
}

Output — what the node produced

{
  "kind": "json",
  "contentType": "application/json",
  "payload": {
    "tenant": "smoke-tenant"
  },
  "body": {
    "tenant": "smoke-tenant"
  }
}

Property reference

Every setting, with its type and default — the same fields shown configured in the panel above.

PropertyTypeDefaultDescription
Tenant header
tenantHeader
string "x-tenant-id" Request header carrying the caller's tenant id (a GUID from Admin → Tenants). Headers arrive lowercased; matched case-insensitively.
Tenant path (override)
tenantPath
field Read the tenant id from a field on the input instead of a header — e.g. userId or headers.x-api-key. Wins over Tenant header when set.
When no tenant id
missingTenant
select "anonymous" Only applies while NO tenant registry is configured — anonymous: id-less requests share one anonymous bucket; deny: they are booted to Limited. With a registry, an id-less caller is just an unknown caller (see Unknown tenant).
anonymousdeny
Tenant set
tenants
string "${variable.tenants}" The tenant registry — a ${variable.NAME} reference to a tenants-type variable (Admin → Tenants), resolved at run start in the editor AND in deployed apps. Unresolved or blank = no registry: every caller gets the node's default limits.
Unknown tenant
unknownTenant
select "deny" A caller the registry doesn't know — a bad id OR no id at all: deny boots them to the Limited output (the default: no registration, no entry); allow lets them through on the node's default limits.
allowdeny
Per second
perSecond
int 0 Max requests per second per tenant. 0 = no per-second window. Tenants can override (blank = inherit, 0 = unlimited).
Per minute
perMinute
int 60 Max requests per minute per tenant. 0 = no per-minute window.
Per hour
perHour
int 0 Max requests per hour per tenant. 0 = no per-hour window.
Per day
perDay
int 0 Max requests per day per tenant. 0 = no per-day window.
Pace: allow
allowCount
int 0 Custom pace, used with Pace: every — allow at most this many requests per pace window (e.g. 1 every 30 seconds). 0 = off.
Pace: every (seconds)
allowEverySeconds
int 0 The custom pace window length in seconds.
Shown when Number(allowCount ?? 0) > 0
Counter scope
scope
string "default" Namespace for the counters. Rate Limit nodes sharing a scope share their windows (one budget across several flows).
Queue (◈)
queueName
string "" Set by the ◈ Queue attachment: over-limit requests are parked in this queue (visible in browse/stats) and released downstream in FIFO order as windows free — smoothing instead of rejecting. Blank = reject to Limited.
Queue broker (◈)
queueBroker
string "" flowdrome.mq broker URL. Blank = this engine's own broker.
Shown when String(queueName ?? "") !== ""
Queue token (◈)
queueToken
string "" x-flowdrome-mq-token for a protected broker.
Shown when String(queueName ?? "") !== ""
Max wait (ms)
maxWaitMs
int 60000 Longest a queued request waits for a free slot before exiting via Limited. Keep below the node Timeout.
Shown when String(queueName ?? "") !== ""
Counter storage (◈)
storageBackend
select "" Set by the ◈ Storage attachment. Blank = the engine's built-in state store (atomic, shared across this engine's workers). redis = counters live in Redis — shared across engines/machines, windows expire server-side.
redis
Redis host (◈)
storageHost
string "" Redis server hostname (copied from the attached Redis node).
Shown when storageBackend === "redis"
Redis port (◈)
storagePort
int 6379 Redis server port.
Shown when storageBackend === "redis"
Redis password (◈)
storagePassword
string "" AUTH password — supports ${credential.NAME.FIELD}. Blank skips AUTH.
Shown when storageBackend === "redis"
Redis database (◈)
storageDb
int 0 Logical database index.
Shown when storageBackend === "redis"
Redis TLS (◈)
storageTls
boolean false Connect to Redis over TLS.
Shown when storageBackend === "redis"
Timeout (ms)
timeoutMs
int 90000 The node's own watchdog — must exceed Max wait so queued requests can actually wait.

Related nodes

The rest of the Logic group — the same folder you’d scan in the editor’s library.

This page is generated from the node registry by gen-node-docs.mjs on every site build — ports, properties, defaults and visibility rules cannot drift from the code. The screenshots and example data are captured from a live Flowdrome by npm run shots:nodes and npm run gen:examples.