Back to Claude Code Router

API Keys

docs/src/content/docs/en/configuration/api-keys.md

3.0.171.9 KB
Original Source

List Fields

FieldCapability
Search API keysFilters the list by key name or key value.
Add API keyOpens the create dialog and generates a new client access key.
NameDisplay name for the key. Use it to identify a client, team, purpose, or automation.
KeyMasked access key. Use Copy API key to copy the full key.
ExpiresExpiration time. After expiration, clients can no longer use the key to access CCR.
LimitsLocal limit summary. Shows No limits configured when no limits are set.
Edit API keyEdits expiration and limits. The key value itself is not shown again.
Remove API keyDeletes the client access key. Deleted keys stop working immediately.

Create And Edit

FieldCapability
NameDisplay name for the new key. Examples: Claude Code - laptop, CI, or a team name.
ExpirationSelects the validity period: Never, 7 days, 30 days, 90 days, or Custom.
Expires atAppears for Custom expiration and sets the exact date and time.
API key createdConfirmation dialog after creation. It displays the full key.
Copy this key now. It may not be shown again.Reminder to copy the key immediately because CCR will not show it again after the dialog closes.

Advanced Settings

Advanced settings adds local limits to a client key. When a limit is reached, requests using that key are rejected or limited; provider-side quota is not changed.

FieldCapability
Advanced settingsExpands or collapses limit editing.
No limits configuredThe key has no local limits.
RequestsLimits by request count.
TokensLimits by token count.
ImagesLimits by image count.
per minuteUses a 1-minute limit window.
per hourUses a 1-hour limit window.
per dayUses a 1-day limit window.
Add limitAdds one limit rule.
Remove limitRemoves the current limit rule.