RateLimitProfileUpdateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Update shape for a rate limit profile.
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 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
required |
string | Operator-facing name, unique within the tenant.
nullablemax length 128
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.
| ||||||||||||||
description
required |
string | Optional operator note explaining why the profile exists.
nullablemax length 512
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.
| ||||||||||||||
scope
required |
RateLimitScope RateLimitScope | The scope the profile binds to.
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.
| ||||||||||||||
scopeIdentifier
required |
string | The identifier at `scope` this profile targets. Leave empty to apply to every
identifier at that scope.
Conditional: When Scope == Global.
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.
| ||||||||||||||
priority
required |
integer (int32) | Tie-break weight among equally specific profiles. Higher wins.
min 0
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 profile 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.
| ||||||||||||||
concurrencyStamp
required |
string | Optimistic concurrency token read from the loaded profile.
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.
|
This model has no documented fields.