Skip to content
Authrim

Set global rate limit profile override

PUT
/api/admin/settings/rate-limits/profile-override
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/rate-limits/profile-override \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "profile": "loadTest", "expires_in": 1200 }'

Sets all rate-limited endpoints to use the selected profile after runtime cache propagation. The loadTest profile always expires automatically; callers may select a 60-3600 second TTL.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
profile
required
string
Allowed values: strict moderate lenient publicRead loginStart sendChallenge loadTest
expires_in

Automatic expiration in seconds. Supported only when profile is loadTest; loadTest defaults to 900 seconds when omitted.

integer
default: 900 >= 60 <= 3600
key
additional properties
Example 
{
  "profile": "loadTest",
  "expires_in": 1200
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Global rate limit profile override updated.

Media type application/json
object
success
boolean
profile_override
string
expires_in
integer | null
effective_config
object
maxRequests
integer
windowSeconds
integer
key
additional properties
kv_key
string
note
string
warning
string
key
additional properties
Example 
{
  "success": true,
  "profile_override": "loadTest",
  "expires_in": 1200,
  "effective_config": {
    "maxRequests": 1000000,
    "windowSeconds": 60
  },
  "kv_key": "rate_limit_profile_override",
  "note": "All rate-limited endpoints will use \"loadTest\" after their runtime caches refresh. Changes may take up to a few minutes to apply across active isolates.",
  "warning": "Load test profile is active. Remember to clear override after testing!"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}