On This Page

Home / Stream/ Reference/ Config Files/api-limits.yml

api-limits.yml ​

Rate limit configuration for the login and SSO/SLO callback endpoints is stored in api-limits.yml.

  • The rateLimits.login settings apply for POST /auth/login.
  • The rateLimits.sso settings apply for /auth/sso/callback (GET and POST) and /auth/slo/callback (GET and POST).
api-limits.yml
# Rate limits
rateLimits:
  # Login rate limit - Rate limit, expressed as maximum number of requests per interval (second,
  # minute, hour, day). Examples: 3/second, 5/minute.
  login:
    # Requests per interval - Maximum number of requests allowed per interval.
    # [integer; min: 1]
    rate:
    # Interval - Time window for the rate limit.
    # One of: second | minute | hour | day
    # [string; default: second]
    interval:
  # SSO/SLO callback rate limit - Rate limit for SSO and SLO callback endpoints. Expressed as
  # maximum number of requests per second, minute, hour, or day. Examples: 3/second, 5/minute. When
  # limit is reached, 429 Too Many Requests HTTP responses are sent.
  sso:
    # Requests per interval - Maximum number of requests allowed per interval.
    # [integer; min: 1]
    rate:
    # Interval - Time window for the rate limit.
    # One of: second | minute | hour | day
    # [string; default: second]
    interval: