Skip to content
Authrim

Get rate limit profile

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

Returns one rate limit profile with resolved values and KV key names.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
profile
required
string

Rate limit profile name.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Rate limit profile.

Media type application/json
object
profile
string
current
object
maxRequests
integer
windowSeconds
integer
key
additional properties
source

Source for maxRequests and windowSeconds.

object
key
additional properties
default

Default profile limits.

object
key
additional properties
kv_keys

KV keys backing this profile.

object
key
additional properties
key
additional properties
Example 
{
  "profile": "standard",
  "current": {
    "maxRequests": 100,
    "windowSeconds": 60
  },
  "source": {
    "maxRequests": "default",
    "windowSeconds": "default"
  },
  "default": {
    "maxRequests": 100,
    "windowSeconds": 60
  },
  "kv_keys": {
    "maxRequests": "rate_limit_standard_max_requests",
    "windowSeconds": "rate_limit_standard_window_seconds"
  }
}

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