getRateLimitScheme()
Returns the full rate limit scheme object, including all rule definitions.
Usage
The following example shows a basic usage of the backend client from @wacht/nextjs/server.
import { wachtClient } from '@wacht/nextjs/server';export async function getRateLimitScheme(slug: string) { const client = await wachtClient(); return client.apiKeys.getRateLimitScheme(slug);}Signature
function getRateLimitScheme( slug: string,): Promise<RateLimitScheme>Parameters
›slug?: string | undefined;
slug?: string | undefined;Target rate-limit scheme slug.
Return value
›slug?: string | undefined;
slug?: string | undefined;Unique rate-limit scheme slug.
›name?: string | undefined;
name?: string | undefined;Rate-limit scheme display name.
›description?: string | undefined;
description?: string | undefined;Optional scheme description.
›rules?: RateLimit[] | undefined;
rules?: RateLimit[] | undefined;Rate-limit rules in this scheme.
›unit?: 'second' | 'minute' | 'hour' | 'day' | undefined;
unit?: 'second' | 'minute' | 'hour' | 'day' | undefined;Rate-limit window unit.
›duration?: number | undefined;
duration?: number | undefined;Window duration count in `unit`.
›max_requests?: number | undefined;
max_requests?: number | undefined;Maximum allowed requests per window.
Behavior
- Loads one scheme by slug with all rule details.
- Use this for read-before-update flows in admin tooling.