Class MtaRateLimitsClient

Tenant-level MTA rate-limit override operations.

Listener-level overrides live on Listener.mtaRateLimit().

Index

Constructors

Methods

Constructors

constructor

new MtaRateLimitsClient(
options: MtaRateLimitsClientOptions,
): MtaRateLimitsClient
Parameters
- options: MtaRateLimitsClientOptions
  The underlying admin client and tenant slug.
Returns MtaRateLimitsClient
- Defined in mta-rate-limits/client.ts:37

Methods

delete

delete(options?: RequestOptions): Promise<void>
Removes the tenant override so the tenant inherits again.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<void>
- Defined in mta-rate-limits/client.ts:84

get

get(options?: RequestOptions): Promise<MTARateLimitOverride>
Reads the effective tenant MTA rate-limit state.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<MTARateLimitOverride>
The override state, including inherited and effective limits.

Throws
NotFoundException When the tenant is not visible.
- Defined in mta-rate-limits/client.ts:51

put

put(
policy: MTARateLimitPolicy,
options?: RequestOptions,
): Promise<MTARateLimitOverride>
Sets the tenant override.

The current inherited limits are fetched first so the policy can be rejected locally when it is looser than what it replaces.
Parameters
- policy: MTARateLimitPolicy
  The override policy; must be no looser than the inherited limits.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<MTARateLimitOverride>
The updated override state.

Throws
Error When the policy is invalid or looser than the inherited limits.
- Defined in mta-rate-limits/client.ts:70