Unkey · Schema

V2RatelimitListOverridesRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
namespace string The id or name of the rate limit namespace to list overrides for.
cursor string Pagination cursor from a previous response. Include this when fetching subsequent pages of results. Each response containing more results than the requested limit will include a cursor value in the pa
limit integer Maximum number of override entries to return in a single response. Use this to control response size and loading performance. - Lower values (10-20): Better for UI displays and faster response times -
View JSON Schema on GitHub

JSON Schema

unkey-v2ratelimitlistoverridesrequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2RatelimitListOverridesRequestBody",
  "title": "V2RatelimitListOverridesRequestBody",
  "additionalProperties": false,
  "properties": {
    "namespace": {
      "description": "The id or name of the rate limit namespace to list overrides for.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "cursor": {
      "description": "Pagination cursor from a previous response. Include this when fetching subsequent pages of results. Each response containing more results than the requested limit will include a cursor value in the pagination object that can be used here.",
      "type": "string"
    },
    "limit": {
      "description": "Maximum number of override entries to return in a single response. Use this to control response size and loading performance.\n\n- Lower values (10-20): Better for UI displays and faster response times\n- Higher values (50-100): Better for data exports or bulk operations\n- Default (10): Suitable for most dashboard views\n\nResults exceeding this limit will be paginated, with a cursor provided for fetching subsequent pages.",
      "type": "integer",
      "default": 10,
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "namespace"
  ],
  "type": "object"
}