Interface RateLimitConfig

Client-wide control-plane rate-limit behaviour.

The v2 control plane signals limits with a 429 response and a Retry-After header (delta-seconds or an HTTP date). When RateLimitConfig.enabled is set, the client waits for that delay and transparently retries GET and DELETE requests up to RateLimitConfig.maxRetries times before surfacing a RateLimitException. POST and PUT are never retried automatically, so they cannot be applied twice or amplify load.

Example

const admin = new AdminClient({
  token,
  rateLimit: { ...defaultRateLimitConfig, maxRetries: 5, maxBackoffMs: 120_000 },
});

interface RateLimitConfig {
    defaultBackoffMs: number;
    enabled: boolean;
    maxBackoffMs: number;
    maxRetries: number;
}

Index

Properties

defaultBackoffMs enabled maxBackoffMs maxRetries

Properties

`Readonly`defaultBackoffMs

defaultBackoffMs: number

Delay used when a 429 has no usable Retry-After, in milliseconds.

`Readonly`enabled

enabled: boolean

Whether 429 responses are retried.

`Readonly`maxBackoffMs

maxBackoffMs: number

Upper bound applied to any server-provided Retry-After, in milliseconds.

`Readonly`maxRetries

maxRetries: number

Maximum retries after the initial attempt.

Interface RateLimitConfig

Example

Index

Properties

Properties

`Readonly`defaultBackoffMs

`Readonly`enabled

`Readonly`maxBackoffMs

`Readonly`maxRetries

Settings

On This Page

Interface RateLimitConfig

Example

Index

Properties

Properties

ReadonlydefaultBackoffMs

Readonlyenabled

ReadonlymaxBackoffMs

ReadonlymaxRetries

Settings

On This Page

`Readonly`defaultBackoffMs

`Readonly`enabled

`Readonly`maxBackoffMs

`Readonly`maxRetries