[PR #5950] docs: fix out-dated api-key docs about rate-limits #14591

New Issue

2026-04-13T09:32:13-05:00

GiteaMirror commented

2026-04-13 09:32:13 -05:00

Original Pull Request: https://github.com/better-auth/better-auth/pull/5950

State: closed
Merged: Yes

Updates the api-key docs regarding rate-limits, also documents how rate-limits apply for get-session requests that use x-api-key.

Linear:
https://linear.app/better-auth/issue/DEV-240/docs-document-api-key-rate-limit-behaviour-when-using-x-api-key

Summary by cubic

Fixes outdated API key rate limit docs and explains how limits apply when sessions are created with x-api-key. Addresses Linear DEV-240.

Bug Fixes
- Clarified where rate limits apply: API key verification and session creation when enableSessionForAPIKeys is on; noted double increment when calling verifyApiKey() and getSession() with x-api-key, with guidance to avoid it.
- Documented sliding-window behavior and error response (tryAgainIn).
- Added how to disable rate limits globally or per key, and updated refill/expiration rules.

^{Written for commit 69dd2b050a. Summary will update automatically on new commits.}

**Original Pull Request:** https://github.com/better-auth/better-auth/pull/5950 **State:** closed **Merged:** Yes --- Updates the api-key docs regarding rate-limits, also documents how rate-limits apply for get-session requests that use `x-api-key`. Linear: https://linear.app/better-auth/issue/DEV-240/docs-document-api-key-rate-limit-behaviour-when-using-x-api-key  --- ## Summary by cubic Fixes outdated API key rate limit docs and explains how limits apply when sessions are created with x-api-key. Addresses Linear DEV-240. - **Bug Fixes** - Clarified where rate limits apply: API key verification and session creation when enableSessionForAPIKeys is on; noted double increment when calling verifyApiKey() and getSession() with x-api-key, with guidance to avoid it. - Documented sliding-window behavior and error response (tryAgainIn). - Added how to disable rate limits globally or per key, and updated refill/expiration rules. <sup>Written for commit 69dd2b050ad7630e15097dbf79cf2d6604addcc2. Summary will update automatically on new commits.</sup>

GiteaMirror added the pull-request label 2026-04-13 09:32:13 -05:00

GiteaMirror closed this issue

2026-04-13 09:32:14 -05:00

Sign in to join this conversation.

Branches Tags

2026-09-01/fix/nuxt-session-hydration

2026-08-31/ci/adopt-shared-ci-tooling

changeset-release/main

main

dependabot/npm_and_yarn/demo/electron/demo-minor-patch-81cd09af96

dependabot/github_actions/github-actions-49d71e140c

2026-08-27/docs/add-markdown-routes

2026-08-27/refactor/share-api-method-rendering

2026-08-26/feat/versioned-docs

feat/adapter-migration-boundary

v1.6.x

feat/account-identity-plan-reporting

2026-08-19/fix/mysql-disabled-index-introspection

2026-08-18/refactor/simplify-cloudflare-fixture

2026-08-19/ci/stabilize-mssql-startup

starsling/drizzle-kit-push-util

docs/1-7-release

2026-08-14/fix/standardize-plugin-types

2026-08-13/fix/dpop-public-url

2026-08-13/fix/acr-values-voluntary

starsling/CHG-forget-processed-cleanup-rows-b8077b74ef9a-4971f8e41755

refactor/device-authorization-oauth-boundary

2026-08-11/fix/api-key-rate-limit-window

feat/oauth-provider-custom-subject

pr-9793-merge

2026-07-31/chore/bump-better-call

2026-07-30/chore/upgrade-better-call

2026-07-30/fix/nextjs-rsc-session-refresh

2026-07-29/refactor/centralize-placeholder-email-generation

refactor/oauth-client-application-type

2026-07-28/fix/anonymous-oauth-proxy-linking

feat/agent-feedback-endpoint

fix/oauth-provider-session-deletion

feat/scim-demo-workflow

feat/scim-active-user-link

feat/sso-provider-user-resolution

feat/identity-provider-accounts

feat/oauth-provider-remove-silence-warnings

changeset-release/release/vercel-announcement

release/vercel-announcement

2026-06-29/docs/optimize-og-images

feat/yandex-social-provider

feat/ssrf-fetch-boundary

codex/pr-10225-next-comments

fix/phone-number-disable-input

perf/router-build-once

fix/oauth-user-provisioning-fields

codex/ignore-compose-override-spellcheck

2026-06-19/fix/stripe-org-reference-scope

feat/webhooks

feat/baseurl-canonical-serving-split

feat/magic-link-expires-in

fix/esbuild-security-bump

chore/sync-main-to-next-20260615

chore/revert-10053

codex/fix-expo-sdk56-dynamic-import

refactor/oauth-provider-client-authentication-module

fix/oauth-no-store-headers

claude/slack-update-stripe-docs-consistency-8Sc0w

local/fix-invite-accept-idempotency

docs/beta-mdx-component-fallback

fix/dependabot-hono-shell-quote

codex/stateless-account-cookie-resolution

fix/admin-create-user-role-escalation

feat/oauth-provider-oidc-acr

refactor/sign-in-challenges

refactor/optional-kysely-dependency

2026-06-06/chore/kysely-changeset

copilot/fix-code-review-comment

starsling/prisma-migration-reset

2026-06-02/fix/next-cookies-defer-rsc

feat/oauth-contribution-protocol

ping-maxwell/c-ping-maxwell/fix-kysely-adapter-core-utils-string-resolution-68c5

temp/server-only-test

2026-05-31/refactor/kysely-joins-json-helpers

2026-04-29/feat/google-include-granted-scopes

2026-04-29/fix/oauth-account-scope-semantics

fix/oauth-callback-path-declarative

2026-05-31/fix/sqlite-dialect-affected-rows

fix/next-cookie-separator

2026-05-29/fix/last-login-method-cookie-prefix

ping-maxwell/c-ping-maxwell/fix-error-link-apostrophe-f89a

client-assertions-main

2026-05-15/ci/fix-sqlite-abi-mismatch

2026-05-15/fix/organization-team-add-cascade

2026-05-15/fix/parse-set-cookie-value-validation

2026-05-13/feat/captcha-wildcard-endpoints

fix/i18n-before-hook-translation

fix/disable-migration-generate

2026-05-10/fix/cookie-drain-order

2026-05-10/feat/hooks-finally

2026-05-09/fix/cookie-drain-order

2026-05-09/feat/hooks-finally

2026-05-08/feat/register-before-send

fix/stripe/subscription-data-merge

2026-05-01/chore/pnpm-v11-harden

chore/pnpm-v11

2026-04-27/fix/nextcookies-idempotent-writes

2026-04-26/fix/harden-proxy-host-validation

2026-04-26/refactor/stripe-callback-signature-cleanup

2026-04-26/fix/stripe-subscription-callback-timing

2026-04-11/fix/sveltekit-app-modules

feat/open-api-zod-contract

feat/oauth-idp-initiated-bounce

2026-04-21/fix/oauth-rfc-input-validation

fix/two-factor-identity-guard

fix/resource

feat/emailpassword-authorize

feat/oauth-provider-at-hash-v2

fix/release-grep-fallback

claude/address-review-comments-JhFLr

feat/async-auth

fix/two-factor-totp-verified-enrollment

feat/plugin-ui

codex/blog-1-6-release-post

2026-04-06/fix/type-any-guards

2026-04-05/chore/downgrade-better-call

2026-04-04/ci/skip-vercel-fork-prs

2026-03-28/ci/add-autofix-ci

chore/release-preview-script

himself65/2026/02/19/role

2026-03-20/docs/improve-website

v1.5.x

2026-03-20/fix/anonymous-onlinkaccount-expo

2026-02-17/fix/anonymous-link-state

fix/8607-saml-inresponseto

fix/8549-scim-patch-noop

v1.4.x

refactor/migration-snapshot-tests

worktree-magic-link-additional-data

chore/migrate-build-to-rollup

worktree-fix-dynamic-baseurl-8447

2026-03-06/chore/public-api-check

fix/close-8156-regression-test

fix/secondary-storage-json-error-handling

himself65/verification-namespace

cursor/issue-8307-validation-79a3

himself65/2026/01/30/error-mdx

v1.4.x-staging

fix/email-otp-user

fix/restrict-full-organization-access-roles

himself65/2026/02/12/count

himself65/2026/02/04/define-plugin

2026-02-04/feat/add-pluralize

cursor/better-auth-js-integration-ec21

cursor/expo-state-mismatch-394c

2026-02-01/fix/org-update-role-sync-members

cursor/issue-7607-investigation-e146

cursor/email-generation-helper-0ff6

himself65/2026/01/21/avoid-spread-operator

himself65/2026/01/14/cli

claude/slack-add-advanced-useplural-WHKYL

feat/hooks-pos

feat/2fa-phone

feat/2fa

fix/rotation

fix/username-check

v1.3.x

refactor/organization

feat/multiple-client-ids-social-providers

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/better-auth#14591