Request

Response

Home

Blog & Tutorials

Discord

GitHub

Contributing

Unkey Docs

API Reference

SDKs

Dashboard

Create

Welcome to Unkey

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

Overview

Learn how root keys in the Unkey API work

Root Keys

Recovering Keys

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

IP Whitelisting

How Unkey protects you from leaked root keys

GitHub Secret Scanning

Identities are a representations of a user, an org or a machine in your application.

Identities can be used to share ratelimits across multiple keys

Ratelimits

Optimize for consistency or latency with different ratelimiting modes.

Consistency vs Latency

Override limits for identifiers without code changes.

Custom overrides

Configure the behavior of the semantic cache

Settings

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

DELETE_PROTECTED

EXPRED

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

Add Permissions

Remove one or more permissions from a key.

Remove Permissions

Overwrite the permissions of a key with a new set of permissions.

Set Permissions

Add Roles

Remove Roles

Overwrite the roles of a key with a new set of roles.

Set Roles

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

Create A Role

Get Role

List Roles

Delete A Role

Create A Permission

Get Permission

List Permissions

Delete A Permission

Create an identity

Get an identity

List identities

Update an identity

Delete an identity

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

revoke

Update

Verify

How to release new versions of the repository.

Versioning

Editor setup to enhance your development experience

Editor Setup (Optional)

Testing

SDK development

Official Libraries

Community Libraries

Create

Request

Response

Official Libraries

Community Libraries

​Request

​Response

​

Request

Response