Update an API key
API Keys
Update an API key
Update an existing API key. Management key required.
PATCH
Update an API key
Authorizations
API key as bearer token in Authorization header
Path Parameters
The hash identifier of the API key to update
Example:
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
Body
application/json
Whether to disable the API key
Example:
false
Whether to include BYOK usage in the limit
Example:
true
New spending limit for the API key in USD
Example:
75
New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
Available options:
daily, weekly, monthly, null Example:
"daily"
New name for the API key
Example:
"Updated API Key Name"
Response
API key updated successfully
The updated API key information
Example:
{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}