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

Sets all rate-limited endpoints to use the selected profile until the override is cleared.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

profile

required

string

Allowed values: strict normal relaxed loadTest

key

additional properties

Example

{
  "profile": "loadTest"
}

Responses

200

Global rate limit profile override updated.

Media type application/json

object

success

boolean

profile_override

string

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",
  "effective_config": {
    "maxRequests": 1000000,
    "windowSeconds": 60
  },
  "kv_key": "rate_limit_profile_override",
  "note": "All rate-limited endpoints now using \"loadTest\" profile. Changes take effect within 10 seconds.",
  "warning": "Load test profile is active. Remember to clear override after testing!"
}

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

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

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

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

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