Skip to content

ServiceKeyWithKey

Service key with the full key value (only returned on creation)

PropertyTypeDescriptionInherited from
allowed_namespaces?string[]Allowed table namespacesServiceKey.allowed_namespaces
created_atstringCreation timestampServiceKey.created_at
created_by?stringUser who created the keyServiceKey.created_by
deprecated_at?stringDeprecation timestamp (for key rotation)ServiceKey.deprecated_at
description?stringDescriptionServiceKey.description
enabledbooleanWhether the key is enabledServiceKey.enabled
expires_at?stringExpiration timestampServiceKey.expires_at
grace_period_ends_at?stringGrace period end for deprecated keysServiceKey.grace_period_ends_at
idstringUnique identifierServiceKey.id
keystringThe full key value - only shown once at creation-
key_prefixstringKey prefix (first 16 chars, for identification)ServiceKey.key_prefix
key_type"anon" | "service"Key type: anon (anonymous access) or service (elevated privileges)ServiceKey.key_type
last_used_at?stringLast usage timestampServiceKey.last_used_at
namestringDisplay nameServiceKey.name
rate_limit_per_hour?numberRate limit per hourServiceKey.rate_limit_per_hour
rate_limit_per_minute?numberRate limit per minuteServiceKey.rate_limit_per_minute
replaced_by?stringID of replacement key (after rotation)ServiceKey.replaced_by
revoked_at?stringRevocation timestampServiceKey.revoked_at
scopesstring[]Permission scopesServiceKey.scopes