Skip to main content

Security

Each workspace has a firewall by caller address and rate limits per client and per address. Both apply to everyone who calls the workspace's endpoints, public or private.

The Security tab with the firewall and rate limits

Open Settings → Security. Workspace admins can change it.

Firewall​

SettingWhat it does
Firewall modeOff, Allow list (only listed addresses may call) or Deny list (listed addresses may not)
AddressesOne IP address or CIDR range per line, e.g. 10.0.0.0/8 or 2001:db8::/32

Refused calls answer 403 ip_blocked. Behind a load balancer or ingress, set opendbapi.serving.trusted-proxies so OpenDBAPI reads the caller's address from X-Forwarded-For; otherwise every call seems to come from the proxy.

Rate limits​

SettingWhat it does
Per clientCalls per minute for each OAuth2 client calling private endpoints. Empty = no limit
Per IP addressCalls per minute for each caller address on public endpoints. Empty = no limit

More calls answer 429 rate_limited with a Retry-After header. Endpoints can have their own limit too (see Endpoint settings).

Every instance applies a change within a few seconds. Limits are counted per instance unless opendbapi.rate-limit.shared=true, which counts them in PostgreSQL across all instances; the Helm chart turns it on.