Query current rate limiting status across the system.
Access: Restricted to users with role: "SUPERADMIN" Purpose: Provides visibility into current rate limiting state for monitoring and debugging.
Response Schema:
{
"message": "Rate limiting status retrieved successfully",
"data": {
"enabled": true,
"storage_type": "database",
"total_active_limits": 1,
"active_limits": [
{
"key": "user:123",
"identifier": "user:123",
"type": "user",
"occurred_at": "2025-11-02T10:15:30+00:00",
"expires_at": "2025-11-02T10:16:30+00:00",
"limit_definition": "5 per minute",
"limit": 5,
"current_count": null,
"time_window_seconds": 60,
"retry_after_seconds": 60,
"user_info": {
"id": "123",
"email": "user@example.com",
"name": "John Doe",
"role": "USER"
}
}
]
}
}
Response Fields:
- enabled: Whether rate limiting is active.
- storage_type: Backend storage type reported by the status endpoint.
- total_active_limits: Count of currently active rate limit entries.
- active_limits: Array with metadata for each active rate limit, including:
- key: Identifier used by the limiter storage (e.g., user:<uuid>).
- identifier: User or IP identifier associated with the limit.
- type: Limit category such as user, ip, or auth.
- occurred_at: Timestamp when the most recent 429 was recorded.
- expires_at: Timestamp when the limit will automatically expire.
- limit_definition: Human-readable description of the breached rule. - limit: Parsed numeric request limit when available.
- current_count: Latest known request count (may be null).
- time_window_seconds: Time window for the limit in seconds.
- retry_after_seconds: Retry hint provided by the limiter, if available. - user_info: Contextual user information for user-type limits (null otherwise).
Error Responses:
- 403 Forbidden: User does not have SUPERADMIN privileges
- 401 Unauthorized: Valid JWT token required
- 500 Internal Server Error: Failed to query rate limiting status
get/api/v1/rate-limit/status
Response
Success
object required
Changes
No recorded changes to this endpoint across all 1 revision of this API.