GET /check — check rate limit status for a userId

The /check endpoint is the single public API surface of RLaaS Users Service. Send a GET request with a userId query parameter and the service will either allow the request (200 OK) or reject it with an HTTP 429 and a plain-text message indicating how many seconds until the window resets.

Request

Method and path: GET /check

userId

string

required

The unique identifier for the user making the request. Used as the key namespace in Redis.

Responses

200 OK
429 Too Many Requests

Request is within the rate limit. The filter passes the request through to the controller, which returns a plain-text confirmation.Response body (plain text):

User is allowed

Example:

curl "http://localhost:8080/check?userId=alice"
# HTTP 200
# User is allowed

Rate limit exceeded for this user. The filter intercepts the request before it reaches the controller and writes a plain-text message directly to the response.Response body (plain text):

User is not allowed...Try after {ttl} seconds.

Where {ttl} is the number of seconds until the window resets.Example:

curl "http://localhost:8080/check?userId=alice"
# HTTP 429
# User is not allowed...Try after 42 seconds.

The TTL value depends on the active algorithm:

Fixed Window: time until the current window key expires in Redis
Sliding Window: the configured window-size value in seconds

Examples

curl "http://localhost:8080/check?userId=alice"

Error behavior

If userId is null or missing from the query string, the filter passes a null userId to the algorithm. The current implementation does not validate the userId parameter — callers should ensure a non-null userId is always provided to avoid undefined behavior in key generation.

Fixed Window algorithm: Redis key format and behavior

Auto-generate your docs

Request
Responses
Examples
Error behavior

Build docs developers (and LLMs) love

Get started for free Talk to us

Endpoints

Algorithms

GET /check — check rate limit status for a userId

Request

Responses

Examples

Error behavior

Build docs developers (and LLMs) love

Endpoints

Algorithms

​Request

​Responses

​Examples

​Error behavior

Build docs developers (and LLMs) love

Request

Responses

Examples

Error behavior