Unkey

# Unkey Docs

## Docs

- [Using Cursor with Unkey](https://unkey.com/docs/ai-code-gen/cursor.md): Leverage Cursor's AI capabilities to build applications with Unkey's APIs
- [AI Code Gen with Unkey](https://unkey.com/docs/ai-code-gen/overview.md): Use AI-powered code generation tools with Unkey's APIs and services
- [Unkey MCP (Model Context Protocol)](https://unkey.com/docs/ai-code-gen/unkey-mcp.md): Connect AI tools to Unkey's APIs using Model Context Protocol
- [Using Windsurf with Unkey](https://unkey.com/docs/ai-code-gen/windsurf.md): Build applications with Windsurf's AI-powered development environment and Unkey's APIs
- [Overview](https://unkey.com/docs/analytics/overview.md): Unkey tracks everything for you
- [Quickstarts](https://unkey.com/docs/analytics/quickstarts.md): Power your own dashboard, reports or usage-based billing
- [Get verification analytics](https://unkey.com/docs/api-reference/v1/analytics/get-verification-analytics.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Create API namespace](https://unkey.com/docs/api-reference/v1/apis/create-api-namespace.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete API keys](https://unkey.com/docs/api-reference/v1/apis/delete-api-keys.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete API namespace](https://unkey.com/docs/api-reference/v1/apis/delete-api-namespace.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get API namespace](https://unkey.com/docs/api-reference/v1/apis/get-api-namespace.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [List API keys](https://unkey.com/docs/api-reference/v1/apis/list-api-keys.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Authentication](https://unkey.com/docs/api-reference/v1/authentication.md): Securely authenticating with the Unkey API
- [Create identity](https://unkey.com/docs/api-reference/v1/identities/create-identity.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete identity](https://unkey.com/docs/api-reference/v1/identities/delete-identity.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get identity](https://unkey.com/docs/api-reference/v1/identities/get-identity.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [List identities](https://unkey.com/docs/api-reference/v1/identities/list-identities.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Update identity](https://unkey.com/docs/api-reference/v1/identities/update-identity.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Add key permissions](https://unkey.com/docs/api-reference/v1/keys/add-key-permissions.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Add key roles](https://unkey.com/docs/api-reference/v1/keys/add-key-roles.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Create API key](https://unkey.com/docs/api-reference/v1/keys/create-api-key.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete API key](https://unkey.com/docs/api-reference/v1/keys/delete-api-key.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get API key](https://unkey.com/docs/api-reference/v1/keys/get-api-key.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get key information](https://unkey.com/docs/api-reference/v1/keys/get-key-information.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get v1keysgetverifications](https://unkey.com/docs/api-reference/v1/keys/get-v1keysgetverifications.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Remove key permissions](https://unkey.com/docs/api-reference/v1/keys/remove-key-permissions.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Remove key roles](https://unkey.com/docs/api-reference/v1/keys/remove-key-roles.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Set key permissions](https://unkey.com/docs/api-reference/v1/keys/set-key-permissions.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Set key roles](https://unkey.com/docs/api-reference/v1/keys/set-key-roles.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Update key credits](https://unkey.com/docs/api-reference/v1/keys/update-key-credits.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Update key settings](https://unkey.com/docs/api-reference/v1/keys/update-key-settings.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Verify API key](https://unkey.com/docs/api-reference/v1/keys/verify-api-key.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Health check](https://unkey.com/docs/api-reference/v1/liveness/health-check.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [/v1/apis.*](https://unkey.com/docs/api-reference/v1/migration/apis.md): Migrate API namespace management endpoints from v1 to v2
- [Errors](https://unkey.com/docs/api-reference/v1/migration/errors.md)
- [/v1/identities.*](https://unkey.com/docs/api-reference/v1/migration/identities.md): Changes and improvements to identity endpoints from v1 to v2
- [Overview](https://unkey.com/docs/api-reference/v1/migration/index.md): Migrate from Unkey API v1 to v2 for enhanced features and improved infrastructure
- [/v1/keys.*](https://unkey.com/docs/api-reference/v1/migration/keys.md): Migrate key management endpoints from v1 to v2
- [/v1/permissions.*](https://unkey.com/docs/api-reference/v1/migration/permissions.md): Migrate from key-based permission patterns to dedicated permission and role management in v2
- [/v1/ratelimits.*](https://unkey.com/docs/api-reference/v1/migration/ratelimiting.md): Migrate rate limiting and override management endpoints from v1 to v2
- [Enqueue key migration](https://unkey.com/docs/api-reference/v1/migrations/enqueue-key-migration.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Migrate keys](https://unkey.com/docs/api-reference/v1/migrations/migrate-keys.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Overview](https://unkey.com/docs/api-reference/v1/overview.md): General information about the API.
- [Create permission](https://unkey.com/docs/api-reference/v1/permissions/create-permission.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Create role](https://unkey.com/docs/api-reference/v1/permissions/create-role.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete permission](https://unkey.com/docs/api-reference/v1/permissions/delete-permission.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete role](https://unkey.com/docs/api-reference/v1/permissions/delete-role.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get permission](https://unkey.com/docs/api-reference/v1/permissions/get-permission.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get role](https://unkey.com/docs/api-reference/v1/permissions/get-role.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [List permissions](https://unkey.com/docs/api-reference/v1/permissions/list-permissions.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [List roles](https://unkey.com/docs/api-reference/v1/permissions/list-roles.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Check rate limit](https://unkey.com/docs/api-reference/v1/ratelimits/check-rate-limit.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Delete rate limit override](https://unkey.com/docs/api-reference/v1/ratelimits/delete-rate-limit-override.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Get rate limit override](https://unkey.com/docs/api-reference/v1/ratelimits/get-rate-limit-override.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [List rate limit overrides](https://unkey.com/docs/api-reference/v1/ratelimits/list-rate-limit-overrides.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Set rate limit override](https://unkey.com/docs/api-reference/v1/ratelimits/set-rate-limit-override.md): **DEPRECATED**: This API version is deprecated. Please migrate to v2. See https://www.unkey.com/docs/api-reference/v1/migration for more information.
- [Create API namespace](https://unkey.com/docs/api-reference/v2/apis/create-api-namespace.md): Create an API namespace for organizing keys by environment, service, or product.

Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations.

**Important**: API names must be unique within your workspace and cannot be changed after creation.

**Required Permissions**

Your root key must have one of the following permissions:
- `api.*.create_api` (to create APIs in any workspace)

- [Delete API namespace](https://unkey.com/docs/api-reference/v2/apis/delete-api-namespace.md): Permanently delete an API namespace and immediately invalidate all associated keys.

Use this for cleaning up development environments, retiring deprecated services, or removing unused resources.
All keys in the namespace are immediately marked as deleted and will fail verification with `code=NOT_FOUND`.

**Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion.
If delete protection is enabled, disable it first through the dashboard or API configuration.

**Required Permissions**

Your root key must have one of the following permissions:
- `api.*.delete_api` (to delete any API)
- `api.<api_id>.delete_api` (to delete a specific API)

- [Get API namespace](https://unkey.com/docs/api-reference/v2/apis/get-api-namespace.md): Retrieve basic information about an API namespace including its ID and name.

Use this to verify an API exists before performing operations, get the human-readable name when you only have the API ID, or confirm access to a specific namespace. For detailed key information, use the `listKeys` endpoint instead.

**Required Permissions**

Your root key must have one of the following permissions:
- `api.*.read_api` (to read any API)
- `api.<api_id>.read_api` (to read a specific API)

- [List API keys](https://unkey.com/docs/api-reference/v2/apis/list-api-keys.md): Retrieve a paginated list of API keys for dashboard and administrative interfaces.

Use this to build key management dashboards, filter keys by user with `externalId`, or retrieve key details for administrative purposes. Each key includes status, metadata, permissions, and usage limits.

**Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.