Skip to main content
The API Keys module allows you to create, manage, and track API keys for your users.

List API Keys

Get all API keys for your account:

Create API Key

Create a new API key for a user:

Create API Key Parameters

string
required
A descriptive name for the API key
string
required
The ID of the user who will use this API key
string
The ID of the plan to associate with this API key
object
Additional metadata for the API key

Get API Key

Retrieve a specific API key by ID:

Update API Key

Update an existing API key:

Update API Key Parameters

string
New name for the API key
object
Updated metadata for the API key

Delete API Key

Delete an API key (soft delete):

Regenerate API Key

Regenerate an existing API key (creates a new key value):

Get API Key Usage

Get usage statistics for a specific API key:

Usage Response

number
Current usage count for the period
number
The limit for the current period
number
Remaining requests for the period
string
When the usage will reset (ISO 8601 format)
string
The current period (day, week, month)

Get API Key Requests

Get detailed request history for an API key:

Request History Response

array
Array of request objects
string
When the request was made (ISO 8601 format)
string
The endpoint that was called
string
The HTTP method used
string
The validation status (allowed/denied)
string
The IP address of the request

Complete Example

API Key Object

The API key object contains the following properties:
string
Unique identifier for the API key
string
The actual API key value (only shown on creation/regeneration)
string
The name of the API key
string
The ID of the user who owns this API key
string
The ID of the plan associated with this API key
string
When the API key was created (ISO 8601 format)
string
When the API key was last updated (ISO 8601 format)
object
Additional metadata for the API key

Next Steps