Skip to main content

Interface: UpdateApiKeyOptions

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / UpdateApiKeyOptions

Interface: UpdateApiKeyOptions

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:181

Options for updating an existing API key. All fields are optional - only provided fields are updated.

Example​

// Update description and add more tokens
const updates: UpdateApiKeyOptions = {
  description: 'Updated description',
  tokenNames: ['token1', 'token2', 'token3']
};

// Upgrade role and extend expiration
const roleUpdate: UpdateApiKeyOptions = {
  role: 'MANAGER',
  expiresAt: '2026-12-31T23:59:59Z'
};

Properties​

delegateAllTokens?​

optional delegateAllTokens?: boolean

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:194

If true, key has access to ALL tokens owned by the user.

description?​

optional description?: string

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:190

Updated description/label. Max 255 characters.

expiresAt?​

optional expiresAt?: string | null

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:204

Updated expiration date in ISO 8601 format. Pass null to remove expiration.

role?​

optional role?: ApiKeyRole

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:185

New role for the API key.

tokenNames?​

optional tokenNames?: string[]

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:199

Updated list of specific tokens to delegate. Replaces existing token delegations.

tokenPermissions?​

optional tokenPermissions?: Record<string, Permission[]>

Defined in: packages/launchpad-sdk/dist/types/api-key.dto.d.ts:210

Per-token permission overrides. Maps tokenName to Permission[]. Replaces existing per-token permissions for the specified tokens.

Since​

5.8.0