Issues

GitHub

Unkey Docs

API Reference

Libraries

Contributing

Discord

Dashboard

Unkey offers IP whitelisting to restrict requests to a specific set of IP addresses.

IP Whitelisting

Overview

Public API Protection

Ratelimiting

How does Unkey work? What security measures are in place?

Learn how root keys in the Unkey API work

Root Keys

Recovering Keys

Next.js

Express

Rate limiting

How to create temporary API Keys in Unkey

Temporary Keys

Usage limited keys

Refill remaining key verifications on a set interval

Refill

Analytics

Separate your keys into live and test environments.

Environments

Keys can be revoked at any time, from the API or the dashboard.

Key Revocation

Enable or disable a key. Disabled keys will not validate.

Disabling Keys

Optimize for consistency or latency with different ratelimiting modes.

Consistency vs Latency

Override limits for identifiers without code changes.

Custom overrides

Configure the threshold for returning responses from the cache

Setting similarity threshold

Why semantic caching

Audit logs for your workspace, allowing you to see the history of all the resource requests made inside your workspace.

Event Types

Vercel

Migrate keys to Unkey

How to authenticate your requests to Unkey's API

Authentication

Introduction

BAD_REQUEST

UNAUTHORIZED

FORBIDDEN

NOT_FOUND

CONFLICT

DISABLED

TOO_MANY_REQUESTS

INTERNAL_SERVER_ERROR

Create a key

Verify a key

Retrieve a key by ID

Updates the configuration of an existing key. Omit fields to leave unchanged.

Update a key

Update a key's remaining limit

Deleted keys are no longer valid and will not be able to be used to authenticate requests.

Delete a key

Retrieve usage numbers

Create an API

Retrieve an API

List keys for an API

Delete all keys of an API

Permanently delete an API and revoke all keys associated with it

Delete an API

Ratelimit anything

Migrate key to Unkey

@unkey/ratelimit

@unkey/nextjs

Hono.js middleware for authenticating API keys

@unkey/hono

@unkey/cache

Get API

List Keys

Create

revoke

Update

Verify

How to release new versions of the repository.

Versioning

Editor setup to enhance your development experience

Get Started

APIs

Ratelimiting

Semantic cache

Audit logs

Integrations

Migrations

IP Whitelisting