createExternalDatabaseConnection( )

Developer Preview

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

Creates a new external database connection.

The externalDatabaseConnection parameter must include a name, endpoint, and configuration details for the external database. If any of these are missing, the external database connection isn't created.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage External Database Connections
Learn more about permission scopes.
Method Declaration
Method Parameters

External database connection details.


Options for creating an external database connection.

Return Type:Promise<ExternalDatabaseConnection>
Was this helpful?