Unkey · Schema

V2RatelimitMultiLimitResponseData

Container for multi-limit rate limit check results

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
passed boolean Overall success indicator for all rate limit checks. This is true if ALL individual rate limit checks passed (all have success: true), and false if ANY check failed. Use this as a quick indicator to d
limits array Array of individual rate limit check results, one for each rate limit check in the request
View JSON Schema on GitHub

JSON Schema

unkey-v2ratelimitmultilimitresponsedata-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2RatelimitMultiLimitResponseData",
  "title": "V2RatelimitMultiLimitResponseData",
  "type": "object",
  "description": "Container for multi-limit rate limit check results",
  "required": [
    "passed",
    "limits"
  ],
  "properties": {
    "passed": {
      "type": "boolean",
      "description": "Overall success indicator for all rate limit checks. This is true if ALL individual rate limit checks passed (all have success: true), and false if ANY check failed.\n\nUse this as a quick indicator to determine if the request should proceed."
    },
    "limits": {
      "type": "array",
      "description": "Array of individual rate limit check results, one for each rate limit check in the request",
      "items": {
        "$ref": "#/components/schemas/V2RatelimitMultiLimitCheck"
      }
    }
  }
}