List rate limit profiles

GET

/api/admin/settings/rate-limits

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/rate-limits \
  --header 'Authorization: Bearer <token>'

Returns all rate limit profiles, source metadata, and the RATE_LIMIT_PROFILE environment override if set.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Rate limit profiles.

Media type application/json

object

profiles

object

key

additional properties

object

current

object

maxRequests

integer

windowSeconds

integer

key

additional properties

source

object

maxRequests

string

windowSeconds

string

key

additional properties

default

object

maxRequests

integer

windowSeconds

integer

key

additional properties

kv_values

object

maxRequests

string | null

windowSeconds

string | null

key

additional properties

kv_keys

object

maxRequests

string

windowSeconds

string

key

additional properties

key

additional properties

env_rate_limit_profile

string | null

cache_ttl_seconds

integer

note

string

key

additional properties

Example

{
  "profiles": {
    "standard": {
      "current": {
        "maxRequests": 100,
        "windowSeconds": 60
      },
      "source": {
        "maxRequests": "default",
        "windowSeconds": "default"
      },
      "default": {
        "maxRequests": 100,
        "windowSeconds": 60
      },
      "kv_values": {
        "maxRequests": null,
        "windowSeconds": null
      }
    },
    "loadTest": {
      "current": {
        "maxRequests": 1000000,
        "windowSeconds": 60
      },
      "source": {
        "maxRequests": "default",
        "windowSeconds": "default"
      },
      "default": {
        "maxRequests": 1000000,
        "windowSeconds": 60
      },
      "kv_values": {
        "maxRequests": null,
        "windowSeconds": null
      }
    }
  },
  "env_rate_limit_profile": null,
  "cache_ttl_seconds": 10,
  "note": "Changes take effect within 10 seconds (cache TTL)"
}

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