RateLimitRuleCreateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Create shape for a rate limit rule.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
profileId
required |
string (uuid) | The profile that owns the rule.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
limiterName
required |
string | The limiter this rule overrides, matched case-insensitively against the registry.
nullablemax length 256
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
algorithm
required |
RateLimitAlgorithm RateLimitAlgorithm | Algorithm override, or null to keep the contributor default.
Conditional: When Algorithm is not null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
permitLimit
required |
integer (int32) | Permit limit override, or null to keep the contributor default.
Conditional: When PermitLimit is not null. Range: 1 to 10000000.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
maxAmount
required |
number (double) | Cumulative amount ceiling override, or null to keep the contributor default.
Conditional: When MaxAmount is not null. Must be > 0.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
windowSeconds
required |
integer (int32) | Window override in seconds, or null to keep the contributor default.
Conditional: When WindowSeconds is not null. Range: 1 to 86400.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
queueLimit
required |
integer (int32) | Burst allowance override, or null to keep the contributor default.
Conditional: When QueueLimit is not null. Range: 0 to 1000000.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
isActive
required |
boolean | Whether the rule participates in resolution.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.