Skip to content

$io.apikey ​

Server API reference.

Functions ​

$io.apikey.retrieve ​

Retrieve API Keys/secrets stored in an 'API Key' Connection.

Usage ​

js
$io.apikey.retrieve(connectionName)

Description ​

Fetches the secrets configured on an 'API Key' Connection.

Notes:

  • A Connection can hold up to four generic secret slots: secret1...secret4.
  • The storage of the keys is always encrypted, this function automatically decrypts it.

Usage Scenarios ​

  • Load API keys/tokens at runtime for outbound requests
  • Centralize credentials for backend jobs without hard-coding
  • Rotate secrets in one place without code changes

Parameters ​

connectionName ​

Type: String

Required: Yes

Name of the 'API Key' Connection to read from.

Output ​

Type: Promise

Resolves to an object with status, data, and err.