Skip to main content
const { token } = await airstore.tokens.create('ws_abc123', { name: 'vm-mount' })
Tokens provide workspace-scoped authentication for the CLI and programmatic access. Use them to mount Airstore on headless VMs or CI runners without interactive login.

create()

Create a workspace token.
const result = await airstore.tokens.create('ws_abc123', {
  name: 'production-vm',
  expiresIn: 86400, // 24 hours
})

console.log(result.token)            // "tok_xxxxxxxxxxxx"
console.log(result.info.external_id) // "tkn_abc123"
The raw token value is only returned at creation time. Store it securely.
Parameters
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesWorkspace external ID
namestringNoDisplay name for the token
memberIdstringNoMember ID to associate the token with
emailstringNoEmail to auto-create a member if memberId not provided
expiresInnumberNo0Expiration in seconds (0 = no expiration)
Returns Promise<TokenCreated>
FieldTypeDescription
tokenstringRaw token value (shown once)
infoTokenToken metadata
info.external_idstringUnique identifier
info.namestringDisplay name
info.token_typestringToken type
info.created_atstringISO 8601 timestamp
member_idstring | undefinedAuto-created member ID

list()

List tokens in a workspace. Returns metadata only — raw token values are never exposed after creation.
const tokens = await airstore.tokens.list('ws_abc123')

for (const t of tokens) {
  console.log(`${t.name} -- last used: ${t.last_used_at ?? 'never'}`)
}
Parameters
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace external ID
Returns Promise<Token[]>
FieldTypeDescription
external_idstringUnique identifier
namestringDisplay name
token_typestringToken type
created_atstringISO 8601 timestamp
last_used_atstring | undefinedLast usage timestamp

revoke()

Revoke a token. It stops working immediately.
await airstore.tokens.revoke('ws_abc123', 'tkn_abc123')
Parameters
ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace external ID
tokenIdstringYesToken external ID
Returns Promise<void>