# RateLimitRuleDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Read shape for a stored rate limit rule.

## Fields
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
- `profileId` (string(uuid)): The profile that owns the rule.
- `profileName` (string): The owning profile's name, resolved for display so the grid does not show a bare identifier.  Empty when the profile has been deleted, which is also when the rule stops applying. (nullable)
- `limiterName` (string): The limiter this rule overrides. (nullable)
- `algorithm` ([RateLimitAlgorithm](https://devportal.demo.winkpg.io/docs/api/models/RateLimitAlgorithm.md)): Algorithm override, or null to keep the contributor default. (nullable)
  Values:
  - `FixedWindow`: Fixed (tumbling) window: the counter resets when the window rolls over. The window identifier is derived from the current UTC instant, so every process agrees on the boundary without coordination.
  - `SlidingWindow`: Sliding window: tracks individual request timestamps over a rolling span using a sorted set. More precise than a fixed window at the cost of more Redis memory.
  - `TokenBucket`: Token bucket: permits replenish at a steady rate and short bursts are allowed up to the bucket capacity.
  - `Concurrency`: Concurrency limiter: bounds the number of concurrent in-flight requests. The slot is held for the duration of the downstream request and released afterwards.
- `permitLimit` (integer(int32)): Permit limit override, or null to keep the contributor default. (nullable)
- `maxAmount` (number(double)): Cumulative amount ceiling override, or null to keep the contributor default. (nullable)
- `windowSeconds` (integer(int32)): Window override in seconds, or null to keep the contributor default. (nullable)
- `queueLimit` (integer(int32)): Burst allowance override, or null to keep the contributor default. (nullable)
- `isActive` (boolean): Whether the rule participates in resolution.
- `concurrencyStamp` (string): Optimistic concurrency token. (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.