GET

Get External Database Connection

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

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

Permissions
Manage External Database Connections
Manage All Data Resources
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/wix-data/v1/external-database-connections/{name}
Path Params
namestringRequired

Name of the external database connection to retrieve.

Response Object
externalDatabaseConnectionExternalDatabaseConnection

Details of the external database connection requested.

Get an external database connection
Request
cURL
curl -X GET \
'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
Response
JSON
{
  "externalDatabaseConnection": {
    "name": "MyExternalDatabase",
    "endpoint": "https://example.com/my-external-database",
    "configuration": {
      "secretKey": "2b723306-4d74-42a2-8438-2ff40da3e6b6"
    },
    "capabilities": {
      "collectionModificationsSupported": true,
      "fieldTypes": ["TEXT", "NUMBER", "DATETIME", "BOOLEAN"],
      "collectionDisplayNameSupported": true,
      "collectionDisplayFieldSupported": true,
      "collectionPermissionsSupported": true,
      "collectionFieldDisplayNameSupported": true,
      "collectionFieldDescriptionSupported": false
    }
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?