Skip to content
Authrim

Update rate limit profile

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

Updates maxRequests and/or windowSeconds for one profile in AUTHRIM_CONFIG.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
profile
required
string

Rate limit profile name.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
maxRequests
integer
>= 1 <= 1000000
windowSeconds
integer
>= 1 <= 86400
key
additional properties
Example 
{
  "maxRequests": 100,
  "windowSeconds": 60
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Rate limit profile updated.

Media type application/json
object
success
boolean
profile
string
updated
object
maxRequests
integer | null
windowSeconds
integer | null
key
additional properties
kv_keys

KV keys updated for this profile.

object
key
additional properties
note
string
key
additional properties
Example 
{
  "success": true,
  "profile": "standard",
  "updated": {
    "maxRequests": 100,
    "windowSeconds": 60
  },
  "kv_keys": {
    "maxRequests": "rate_limit_standard_max_requests",
    "windowSeconds": "rate_limit_standard_window_seconds"
  },
  "note": "Changes will take effect within 10 seconds (cache TTL)"
}

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"
}