updateRateLimitScheme()

Updates the name, description, or rules for an existing scheme.

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 updateRateLimitScheme(slug: string) {  const client = await wachtClient();  return client.apiKeys.updateRateLimitScheme(slug, {    name: 'Updated API Limits',    rules: [{ unit: 'minute', duration: 1, max_requests: 200 }],  });}

Signature

function updateRateLimitScheme(  slug: string,  request: UpdateRateLimitSchemeRequest,): Promise<RateLimitScheme>

UpdateRateLimitSchemeRequest

›

slug?: string | undefined;

Target scheme slug.

›

name?: string | undefined;

Updated scheme display name.

›

description?: string | undefined;

Updated scheme description.

›

rules?: RateLimit[] | undefined;

Updated scheme rules.

›

unit?: 'second' | 'minute' | 'hour' | 'day' | undefined;

Rate-limit window unit.

›

duration?: number | undefined;

Window duration count in `unit`.

›

max_requests?: number | undefined;

Maximum allowed requests per window.

Return value

›

slug?: string | undefined;

Updated scheme slug.

›

name?: string | undefined;