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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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

External database connection details.

optionsCreateExternalDatabaseConnectionOptionsRequired

Options for creating an external database connection.

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