Skip to content

ServiceKey

Service key for API authentication Each tenant has their own service_keys table in their database

PropertyTypeDescription
allowed_namespaces?string[]Allowed table namespaces
created_atstringCreation timestamp
created_by?stringUser who created the key
deprecated_at?stringDeprecation timestamp (for key rotation)
description?stringDescription
enabledbooleanWhether the key is enabled
expires_at?stringExpiration timestamp
grace_period_ends_at?stringGrace period end for deprecated keys
idstringUnique identifier
key_prefixstringKey prefix (first 16 chars, for identification)
key_type"anon" | "service"Key type: anon (anonymous access) or service (elevated privileges)
last_used_at?stringLast usage timestamp
namestringDisplay name
rate_limit_per_hour?numberRate limit per hour
rate_limit_per_minute?numberRate limit per minute
replaced_by?stringID of replacement key (after rotation)
revoked_at?stringRevocation timestamp
scopesstring[]Permission scopes