Appearance
API Key Connection
The API Key Connection stores one required secret and up to three additional secrets for trusted server-side use. Use it for credentials that do not have a dedicated Connection service or when custom Cloud Flow code needs a protected key, password, or token.
An API Key Connection is not a general frontend secret store. Its retrieval command is server-only, and secret values must not be returned to Page Flow or exposed in logs and error messages.
Capabilities
| Capability | Availability |
|---|---|
| Connection service identifier | apisecret |
| Page Flow command | Not available |
| Cloud Flow command | Retrieve |
| Server API | $io.apikey and $io.system.apiKeyInfo(...) |
| Connection method | retrieve |
| Authenticated SDK object | Not applicable |
Use apisecret when an interface requires the Connection service identifier. $io.system.apiKeyInfo(...) accepts the Connection name directly and does not require the service identifier.
Profile Settings
The Profile stores:
| Setting | Requirement |
|---|---|
| Secret | Required primary value. |
| Secret2 | Optional additional value. |
| Secret3 | Optional additional value. |
| Secret4 | Optional additional value. |
Use a separate Profile when credentials have different owners, environments, rotation schedules, or access requirements.
The Connection itself has no additional service settings beyond its name and selected Profile.
Access
The Connection exposes a Retrieve Access operation. Public access is not allowed.
Even with this policy, retrieve secrets only inside trusted Cloud Flow code. Do not create a Web Hook that returns the stored values to a caller. Instead, use the values to authenticate the required server-side operation and return a controlled result.
Using the Connection
Cloud Flow can use the Retrieve server command, the retrieve Connection method, $io.apikey.retrieve(...), or $io.system.apiKeyInfo(connectionName).
Use the Server API reference for the exact returned object. Treat every returned property as sensitive.
Rotation and Maintenance
When rotating a credential:
- Update or replace the Profile.
- Identify every Connection that uses it.
- Test each dependent Cloud Flow.
- Confirm the previous credential has been revoked at the provider when appropriate.
Updating an existing Profile affects the development and published Connections that share it; the Profile change does not wait for a Project publish. If Connections are edited to select a replacement Profile, publish the Project so those Connection changes reach the published version.
Avoid placing provider-specific configuration into generic secret fields when a dedicated Connection provides safer authentication, scoped OAuth, or an authenticated SDK object.