Skip to main content

index/interfaces/ApiKeyData.md

API key data returned in responses. Note: The raw key is NOT included - it's only returned on creation.

Extended by​

Properties​

PropertyTypeDescription
createdAtstringCreation timestamp (ISO 8601)
delegateAllTokensbooleanWhether key has access to all owner's tokens
descriptionstring | nullUser's description/label
expiresAtstring | nullExpiration timestamp (ISO 8601) or null if never expires
idnumberUnique identifier
keyPrefixstringFirst 8 characters for identification (e.g., "glp_abc1")
lastUsedAtstring | nullLast time key was used (ISO 8601) or null if never used
roleApiKeyRoleRole determining permissions
sourceTypeApiKeySourceIndicates whether the key holder owns tokens (OWNER) or only has moderator access (MODERATOR). Since 9.1.0
tokenNamesstring[] | nullList of specifically delegated token names (null if delegateAllTokens is true)
tokenPermissions?Record<string, Permission[]> | nullPer-token permission overrides (null if no overrides set). Maps tokenName to Permission[]. Since 5.8.0
updatedAtstringLast update timestamp (ISO 8601)