getExternalDatabaseConnection( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves an external database connection by name.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage External Database Connections
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
namestringRequired

Name of the external database connection to retrieve.

Returns
Return Type:Promise<ExternalDatabaseConnection>
Did this help?