GET

List External Database Connections


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 a list of all external database collections associated with the site or project.

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

Query Params
paging.limitintegerminimum 0format int32

Number of items to load.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

Response Object
externalDatabaseConnectionsArray <ExternalDatabaseConnection>

List of external database connections.


pagingMetadataPagingMetadata

Paging metadata

List all external database connections
Request
cURL
curl -X GET \ 'https://www.wixapis.com/wix-data/v1/external-database-connections' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "externalDatabaseConnections": [ { "name": "MyFirstExternalDatabase", "endpoint": "https://example.com/my-first-external-database", "configuration": { "secretKey": "fkapguvn-kf5z-kfo4-kg94-nfoem4pamfi6" }, "capabilities": { "collectionModificationsSupported": false, "fieldTypes": [], "collectionDisplayNameSupported": false, "collectionDisplayFieldSupported": false, "collectionPermissionsSupported": false, "collectionFieldDisplayNameSupported": false, "collectionFieldDescriptionSupported": false } }, { "name": "MySecondExternalDatabase", "endpoint": "https://example.com/my-second-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": true } }, { "name": "MyThirdExternalDatabase", "endpoint": "https://example.com/my-third-external-database", "configuration": { "secretKey": "5bdfed23-629a-4fa2-85f7-c3dba9b5d423" }, "capabilities": { "collectionModificationsSupported": false, "fieldTypes": [] } } ] }
Errors

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

Did this help?