Consume Rate Limiter — Reference

Charge a request against the selected rate budget. Node.js only.

Before you begin

• An appropriately configured Server Connect action and isolated test inputs.

Consume Rate Limiter

Charge a request against the selected rate budget. Node.js only.

Settings

Setting	Meaning
Rate Limiter	Select a named definition, or the global limiter if one is enabled. Leaving this empty when no global limiter is configured does not create a limiter or enforce a budget.
Points	Points to consume for the request. Default 1. Use an explicit positive number.
Status	HTTP status returned on exhaustion when Throw is off. The default is 429.
Message	The returned or thrown message when the budget is exhausted. The default is Too Many Requests.
Throw	Raises an exception on exhaustion instead of sending the normal failure response. Default off. Use Try/Catch only when you have chosen the throw behavior.

Verification example

Use a disposable limiter definition with two points per minute and send three test requests from the same client key. Inspect the third response or caught error. Then wait for the configured reset and verify that requests are accepted again.

Behavior and limits

Named limiter consumption uses the runtime’s request IP. The global limiter can use a configured authenticated identity for its private budget. Proxy/IP configuration and the selected backing store therefore affect who shares a limit. Header behavior differs between named and global paths; do not assume every named limiter response adds Retry-After.

Connect this step to the workflow

Place the check or file operation before the work that depends on it, then verify the final HTTP response and any resulting data or file changes.

Check your result

You can configure this operation and verify both its expected result and its failure boundary.