Unkey · Schema

V2RatelimitDeleteOverrideRequestBody

Deletes an existing rate limit override. This permanently removes a custom rate limit rule, reverting affected identifiers back to the default rate limits for the namespace. Use this endpoint when you need to: - Remove special rate limit rules that are no longer needed - Reset entities back to standard rate limits - Clean up temporary overrides - Remove outdated tiering or custom limit rules - Fix misconfigured overrides Once deleted, the override cannot be recovered, and the operation takes effect immediately.

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
namespace string The id or name of the namespace containing the override.
identifier string The exact identifier pattern of the override to delete. This must match exactly as it was specified when creating the override. Important notes: - This is case-sensitive and must match exactly - Inclu
View JSON Schema on GitHub

JSON Schema

unkey-v2ratelimitdeleteoverriderequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2RatelimitDeleteOverrideRequestBody",
  "title": "V2RatelimitDeleteOverrideRequestBody",
  "description": "Deletes an existing rate limit override. This permanently removes a custom rate limit rule, reverting affected identifiers back to the default rate limits for the namespace.\n\nUse this endpoint when you need to:\n- Remove special rate limit rules that are no longer needed\n- Reset entities back to standard rate limits\n- Clean up temporary overrides\n- Remove outdated tiering or custom limit rules\n- Fix misconfigured overrides\n\nOnce deleted, the override cannot be recovered, and the operation takes effect immediately.",
  "additionalProperties": false,
  "properties": {
    "namespace": {
      "description": "The id or name of the namespace containing the override.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "identifier": {
      "description": "The exact identifier pattern of the override to delete. This must match exactly as it was specified when creating the override.\n\nImportant notes:\n- This is case-sensitive and must match exactly\n- Include any wildcards (*) that were part of the original pattern\n- For example, if the override was created for 'premium_*', you must use 'premium_*' here, not a specific ID\n\nAfter deletion, any identifiers previously affected by this override will immediately revert to using the default rate limit for the namespace.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "required": [
    "namespace",
    "identifier"
  ],
  "type": "object"
}