Skip to content
Authrim

Get global rate limit profile override

GET
/api/admin/rate-limits/profile-override
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/rate-limits/profile-override \
  --header 'Authorization: Bearer <token>'

Returns the global rate limit profile override, if one is active (503 while it cannot be read).

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Global rate limit profile override.

Media type application/json
object
profile_override

The stored override, while it applies.

string | null
expires_at

Unix time (seconds) after which the stored override no longer applies (a loadTest override always expires); null when it does not expire.

integer | null
env_profile_override

RATE_LIMIT_PROFILE, which applies when no override is stored.

string | null
effective_profile_override

The override the rate limiter applies (stored, else RATE_LIMIT_PROFILE).

string | null
kv_key
string
valid_profiles
Array<string>
note
string
key
additional properties
Example 
{
  "profile_override": null,
  "expires_at": null,
  "env_profile_override": null,
  "effective_profile_override": null,
  "kv_key": "rate_limit_profile_override",
  "valid_profiles": [
    "strict",
    "moderate",
    "lenient",
    "publicRead",
    "loginStart",
    "sendChallenge",
    "loadTest"
  ],
  "note": "No profile override set. Endpoints use their default profiles."
}

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

503

Section titled “503 ”

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