External Database Connection Object


An external database connection defines a connection between an external database and a Wix site.

Properties
namestringminLength 1maxLength 255

Name of the external database connection.

An external database connection can connect to one or more external data collections or tables. These appear as connectionName/dataCollectionId.


endpointstringformat WEB_URL

Base URL for accessing and managing data in the external database. For example: https://example.com/my-external-database.


configurationstruct

Settings specified to the external database connection as part of each request.

These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API.


connectionStatusConnectionStatusRead-only

Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.


publicKeystringRead-onlymaxLength 128

Public key used to validate requests to the external database.


capabilitiesCapabilitiesRead-only

Capabilities of the external database.

ExternalDatabaseConnection
JSON
Did this help?