Rate Limit Settings

The Rate Limit Settings APIs provide operations to manage settings and configurations surrounding rate limiting in your Okta organization.

Retrieve the rate limit admin notification settings
OAuth 2.0:
  • okta.rateLimits.read

Retrieves the currently configured Rate Limit Admin Notification Settings

Responses
200

OK

403

Forbidden

429

Too Many Requests

get/api/v1/rate-limit-settings/admin-notifications
Request samples 
Response samples 
application/json
{
  • "notificationsEnabled": true
}
Replace the rate limit admin notification settings
OAuth 2.0: 
  • okta.rateLimits.manage
Replaces the Rate Limit Admin Notification Settings and returns the configured properties


Request 
Request Body schema: application/json
required
notificationsEnabled
required
boolean
 
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


put/api/v1/rate-limit-settings/admin-notifications
Request samples 
application/json
{
  • "notificationsEnabled": true
}
Response samples 
application/json
{
  • "notificationsEnabled": true
}
Retrieve the per-client rate limit settings
OAuth 2.0: 
  • okta.rateLimits.read
Retrieves the currently configured Per-Client Rate Limit Settings


Responses 
200
OK


403
Forbidden


429
Too Many Requests


get/api/v1/rate-limit-settings/per-client
Request samples 
Response samples 
application/json
{
  • "defaultMode": "ENFORCE"
}
Replace the per-client rate limit settings
OAuth 2.0: 
  • okta.rateLimits.manage
Replaces the Per-Client Rate Limit Settings and returns the configured properties


Request 
Request Body schema: application/json
required
defaultMode
required
string (PerClientRateLimitMode) 
 Enum: "DISABLE" "ENFORCE" "PREVIEW"  
object
A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode. Overrides the defaultMode property for the specified use cases.


 
LOGIN_PAGE
string (PerClientRateLimitMode) 
 Enum: "DISABLE" "ENFORCE" "PREVIEW"  
OAUTH2_AUTHORIZE
string (PerClientRateLimitMode) 
 Enum: "DISABLE" "ENFORCE" "PREVIEW"  
OIE_APP_INTENT
string (PerClientRateLimitMode) 
 Enum: "DISABLE" "ENFORCE" "PREVIEW"  
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


put/api/v1/rate-limit-settings/per-client
Request samples 
application/json
{
  • "defaultMode": "ENFORCE"
}
Response samples 
application/json
{
  • "defaultMode": "ENFORCE"
}
Retrieve the rate limit warning threshold percentage
OAuth 2.0: 
  • okta.rateLimits.read
Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded


Responses 
200
OK


403
Forbidden


429
Too Many Requests


get/api/v1/rate-limit-settings/warning-threshold
Request samples 
Response samples 
application/json
{
  • "warningThreshold": 66
}
Replace the rate limit warning threshold percentage
OAuth 2.0: 
  • okta.rateLimits.manage
Replaces the Rate Limit Warning Threshold Percentage and returns the configured property


Request 
Request Body schema: application/json
warningThreshold
required
integer  [ 30 .. 90 ] 
The threshold value (percentage) of a rate limit that, when exceeded, triggers a warning notification. By default, this value is 90 for Workforce orgs and 60 for CIAM orgs.


 
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


put/api/v1/rate-limit-settings/warning-threshold
Request samples 
application/json
{
  • "warningThreshold": 66
}
Response samples 
application/json
{
  • "warningThreshold": 66
}