> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Rate Limiting

> Configure API and platform rate limits, review violations, and monitor usage across the Encore OS tenant.

Rate limiting administration hub at `/settings/rate-limiting` where platform administrators configure rate-limit rules, review violations, and monitor usage.

## Overview

The Rate Limiting Hub page is a three-tab interface: **Configuration**, **Violations**, and **Usage**. Configuration and Violations tabs are guarded by `pf.rate-limits.manage`; the Usage tab is guarded by `pf.rate-limits.view_usage`. The active tab is preserved in the URL via the `tab` query parameter. Each tab renders a dedicated component (`RateLimitConfigTable`, `ViolationsTable`, `UsageDashboard`) loaded from the rate-limiting platform module.

## Who it's for

**Required permission:** `pf.rate-limits.manage` (Configuration and Violations tabs); `pf.rate-limits.view_usage` (Usage tab)

## Before you start

* You must hold the appropriate permission for the tab you intend to use.
* An active organization context is required; the page shows a loading skeleton until one is available.

## Steps

1. Navigate to `/settings/rate-limiting`.
2. On the **Configuration** tab, review existing rate-limit rules. Add or modify rules as needed.
3. On the **Violations** tab, inspect recent limit breaches.
4. On the **Usage** tab, review current API consumption metrics.

## Key concepts

**Rate-limit rule** — A policy that caps request frequency for a given scope (endpoint, user, or other). SME: confirm configurable dimensions.

**Violation** — A recorded instance where a request exceeded a configured limit.

**Usage dashboard** — Aggregated view of request counts relative to configured limits.

## Related

<Columns cols={2}>
  <Card title="Platform Foundation" icon="layer-group" href="/pf/overview">
    Platform Foundation overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index" />
</Columns>

<Note>
  This page documents shipped product behavior. It is not medical, legal, or
  billing advice. Verify against your organization's policies and applicable
  regulations before using it for clinical, compliance, or billing decisions.
  Protected health information (PHI) shown in the product is governed by your
  tenant's access controls and is never exposed in this documentation.
</Note>

<Accordion title="Documentation sources">
  * src/routes/platform.tsx
  * src/platform/rate-limiting/pages/RateLimitingHubPage.tsx
  * src/platform/rate-limiting/components/RateLimitConfigTable.tsx
</Accordion>
