{"id":"34004dc7-1b50-432e-a978-4641d8a0f9dd","createdDate":"2024-05-30T08:11:45.885Z","updatedDate":"2024-05-30T08:11:45.885Z","resourceId":"ae9cab4a-b40b-48f1-b1b3-e659595e3440","api":{"schema":{"object":{"displayName":"External Database Connection Object","description":"An external database connection defines a connection between an external database and a Wix site or project.","slug":"external-database-connection-object","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","legacyExamples":[{"title":"ExternalDatabaseConnection","content":"{\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\": {\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"connectionStatus\": {\n \"successful\": true,\n \"causeOfFailure\": \"NONE\",\n \"hasCollections\": \"YES\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": []\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"methods":[{"summary":"Get External Database Connection","description":"Retrieves an external database connection by name.","operationId":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.GetExternalDatabaseConnection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"name","description":"Name of the external database connection to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v1/external-database-connections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v1/external-database-connections","destinationPath":"/v1/external-database-connections","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"GetExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"Get an external database connection","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": true,\n \"fieldTypes\": [\"TEXT\", \"NUMBER\", \"DATETIME\", \"BOOLEAN\"],\n \"collectionDisplayNameSupported\": true,\n \"collectionDisplayFieldSupported\": true,\n \"collectionPermissionsSupported\": true,\n \"collectionFieldDisplayNameSupported\": true,\n \"collectionFieldDescriptionSupported\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"get","path":"/v1/external-database-connections/{name}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"GetExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"Get an external database connection","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": true,\n \"fieldTypes\": [\"TEXT\", \"NUMBER\", \"DATETIME\", \"BOOLEAN\"],\n \"collectionDisplayNameSupported\": true,\n \"collectionDisplayFieldSupported\": true,\n \"collectionPermissionsSupported\": true,\n \"collectionFieldDisplayNameSupported\": true,\n \"collectionFieldDescriptionSupported\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Get External Database Connection","slugifiedName":"get-external-database-connection"}},{"summary":"Delete External Database Connection","description":"Deletes an external database connection.\n\n> **Note:** Once an external database connection is deleted, it can't be restored. To reconnect the database you need to [create a new external database connection](https://dev.wix.com/api/rest/wix-data/wix-data/external-database-connections/create-external-database-connection).","operationId":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.DeleteExternalDatabaseConnection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"name","description":"Name of the external database connection to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v1/external-database-connections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v1/external-database-connections","destinationPath":"/v1/external-database-connections","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"External Database Connection Deleted","description":"Triggered when an external database connection is deleted.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.data.v1.external_database_connection_deleted","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.DELETE_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"DeleteExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"Delete an external database connection","request":"curl -X DELETE \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"delete","path":"/v1/external-database-connections/{name}","rpcOnly":false,"triggeredEvents":[{"title":"External Database Connection Deleted","description":"Triggered when an external database connection is deleted.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.data.v1.external_database_connection_deleted","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.DELETE_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"DeleteExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"Delete an external database connection","request":"curl -X DELETE \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Delete External Database Connection","slugifiedName":"delete-external-database-connection"}},{"summary":"List External Database Connections","description":"Retrieves a list of all external database collections associated with the site or project.","operationId":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.ListExternalDatabaseConnections","parameters":[{"name":"paging","in":"query","description":"Paging","required":false,"schema":{"description":"Paging","$ref":"#/components/schemas/upstream.externaldatabase.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v1/external-database-connections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v1/external-database-connections","destinationPath":"/v1/external-database-connections","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.LIST_EXTERNAL_DATABASE_CONNECTIONS"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsResponse"},"legacyExamples":[{"name":"ListExternalDatabaseConnections","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"List all external database connections","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"externalDatabaseConnections\": [\n {\n \"name\":\"MyFirstExternalDatabase\",\n \"endpoint\":\"https://example.com/my-first-external-database\",\n \"configuration\":{\n \"secretKey\":\"fkapguvn-kf5z-kfo4-kg94-nfoem4pamfi6\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": [],\n \"collectionDisplayNameSupported\": false,\n \"collectionDisplayFieldSupported\": false,\n \"collectionPermissionsSupported\": false,\n \"collectionFieldDisplayNameSupported\": false,\n \"collectionFieldDescriptionSupported\": false\n }\n },\n {\n \"name\":\"MySecondExternalDatabase\",\n \"endpoint\":\"https://example.com/my-second-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": true,\n \"fieldTypes\": [\"TEXT\", \"NUMBER\", \"DATETIME\", \"BOOLEAN\"],\n \"collectionDisplayNameSupported\": true,\n \"collectionDisplayFieldSupported\": true,\n \"collectionPermissionsSupported\": true,\n \"collectionFieldDisplayNameSupported\": true,\n \"collectionFieldDescriptionSupported\": true\n }\n },\n {\n \"name\":\"MyThirdExternalDatabase\",\n \"endpoint\":\"https://example.com/my-third-external-database\",\n \"configuration\":{\n \"secretKey\":\"5bdfed23-629a-4fa2-85f7-c3dba9b5d423\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": []\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"get","path":"/v1/external-database-connections","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.LIST_EXTERNAL_DATABASE_CONNECTIONS"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsResponse"},"legacyExamples":[{"name":"ListExternalDatabaseConnections","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"List all external database connections","request":"curl -X GET \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '","response":"{\n \"externalDatabaseConnections\": [\n {\n \"name\":\"MyFirstExternalDatabase\",\n \"endpoint\":\"https://example.com/my-first-external-database\",\n \"configuration\":{\n \"secretKey\":\"fkapguvn-kf5z-kfo4-kg94-nfoem4pamfi6\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": [],\n \"collectionDisplayNameSupported\": false,\n \"collectionDisplayFieldSupported\": false,\n \"collectionPermissionsSupported\": false,\n \"collectionFieldDisplayNameSupported\": false,\n \"collectionFieldDescriptionSupported\": false\n }\n },\n {\n \"name\":\"MySecondExternalDatabase\",\n \"endpoint\":\"https://example.com/my-second-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": true,\n \"fieldTypes\": [\"TEXT\", \"NUMBER\", \"DATETIME\", \"BOOLEAN\"],\n \"collectionDisplayNameSupported\": true,\n \"collectionDisplayFieldSupported\": true,\n \"collectionPermissionsSupported\": true,\n \"collectionFieldDisplayNameSupported\": true,\n \"collectionFieldDescriptionSupported\": true\n }\n },\n {\n \"name\":\"MyThirdExternalDatabase\",\n \"endpoint\":\"https://example.com/my-third-external-database\",\n \"configuration\":{\n \"secretKey\":\"5bdfed23-629a-4fa2-85f7-c3dba9b5d423\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": []\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"List External Database Connections","slugifiedName":"list-external-database-connections"}},{"summary":"Create External Database Connection","description":"Creates a new external database connection.\n\nThe request body must include a `name`, an `endpoint`, and `configuration` details for the external database within the `externalDatabaseConnection` body parameter.\nIf any of these are missing, the external database connection isn't created.","operationId":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.CreateExternalDatabaseConnection","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v1/external-database-connections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v1/external-database-connections","destinationPath":"/v1/external-database-connections","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateExternalDatabaseConnectionRequest","description":"","properties":{"externalDatabaseConnection":{"description":"External database connection details.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"connectionType":{"description":"Connection type.","title":"connectionType","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ConnectionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["externalDatabaseConnection","externalDatabaseConnection.name","connectionType"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"External Database Connection Created","description":"Triggered when an external database connection is created.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.data.v1.external_database_connection_created","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.CREATE_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"CreateExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","order":2,"content":{"title":"Create an external database connection with additional configuration","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\",\n \"tenantId\":\"my-wix-site\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n }\n },\n \"connectionType\": \"STANDALONE\"\n}'","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\",\n \"tenantId\":\"my-wix-site\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n },\n \"connectionStatus\": {\n \"successful\": true,\n \"causeOfFailure\": \"NONE\",\n \"hasCollections\": \"YES\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": []\n }\n }\n}"}},{"name":"CreateExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","order":1,"content":{"title":"Create an external database connection","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n }\n },\n \"connectionType\": \"STANDALONE\"\n}'","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\": {\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"connectionStatus\": {\n \"successful\": true,\n \"causeOfFailure\": \"NONE\",\n \"hasCollections\": \"YES\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": true,\n \"fieldTypes\": [\"TEXT\", \"NUMBER\", \"DATETIME\", \"BOOLEAN\"],\n \"collectionDisplayNameSupported\": true,\n \"collectionDisplayFieldSupported\": true,\n \"collectionPermissionsSupported\": true,\n \"collectionFieldDisplayNameSupported\": true,\n \"collectionFieldDescriptionSupported\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"post","path":"/v1/external-database-connections","rpcOnly":false,"triggeredEvents":[{"title":"External Database Connection Created","description":"Triggered when an external database connection is created.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.data.v1.external_database_connection_created","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.CREATE_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"CreateExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","order":2,"content":{"title":"Create an external database connection with additional configuration","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\",\n \"tenantId\":\"my-wix-site\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n }\n },\n \"connectionType\": \"STANDALONE\"\n}'","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\",\n \"tenantId\":\"my-wix-site\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n },\n \"connectionStatus\": {\n \"successful\": true,\n \"causeOfFailure\": \"NONE\",\n \"hasCollections\": \"YES\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": false,\n \"fieldTypes\": []\n }\n }\n}"}},{"name":"CreateExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","order":1,"content":{"title":"Create an external database connection","request":"curl -X POST \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n }\n },\n \"connectionType\": \"STANDALONE\"\n}'","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\": {\n \"secretKey\": \"2b723306-4d74-42a2-8438-2ff40da3e6b6\"\n },\n \"connectionStatus\": {\n \"successful\": true,\n \"causeOfFailure\": \"NONE\",\n \"hasCollections\": \"YES\"\n },\n \"capabilities\": {\n \"collectionModificationsSupported\": true,\n \"fieldTypes\": [\"TEXT\", \"NUMBER\", \"DATETIME\", \"BOOLEAN\"],\n \"collectionDisplayNameSupported\": true,\n \"collectionDisplayFieldSupported\": true,\n \"collectionPermissionsSupported\": true,\n \"collectionFieldDisplayNameSupported\": true,\n \"collectionFieldDescriptionSupported\": false\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Create External Database Connection","slugifiedName":"create-external-database-connection"}},{"summary":"Update External Database Connection","description":"Updates an external database connection.\n\nAn external database collection name must be submitted as a path parameter.\nIf an existing external database connection is found with the same name, that connection's details are updated.\nIf no external database connection has that name, the request fails.\n\n> **Note:** After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.","operationId":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService.UpdateExternalDatabaseConnection","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"externalDatabaseConnection.name","description":"Name of the external database connection.\nAn external database connection may connect to one or more external data collections or tables.\nThese are represented as `connectionName/dataCollectionId`.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/wix-data/v1/external-database-connections","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/wix-data/v1/external-database-connections","destinationPath":"/v1/external-database-connections","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateExternalDatabaseConnectionRequest","description":"","properties":{"externalDatabaseConnection":{"description":"Updated external database connection details. The existing connection is replaced with this version.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["externalDatabaseConnection","externalDatabaseConnection.name"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"External Database Connection Updated","description":"Triggered when an external database connection is updated.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.data.v1.external_database_connection_updated","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.UPDATE_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"UpdateExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"Update an external database connection","request":"curl -X PUT \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"externalDatabaseConnection\": {\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\",\n \"tenantId\":\"my-wix-site-updated\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n }\n }\n}'","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\",\n \"tenantId\":\"my-wix-site-updated\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n },\n \"connectionStatus\": {"}}],"sourceRepo":"git@github.com:wix-private/cloud.git"},"httpMethod":"put","path":"/v1/external-database-connections/{externalDatabaseConnection.name}","rpcOnly":false,"triggeredEvents":[{"title":"External Database Connection Updated","description":"Triggered when an external database connection is updated.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.data.v1.external_database_connection_updated","sourceRepo":"git@github.com:wix-private/cloud.git"}],"serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_DATA.UPDATE_EXTERNAL_DATABASE_CONNECTION"],"externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"protoArtifactId":"com.wixpress.cloud:cloud-data-api","serviceArtifactId":"com.wixpress.cloud.cloud-data","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionRequest","responseMessage":"com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionResponse"},"legacyExamples":[{"name":"UpdateExternalDatabaseConnection","serviceName":"ExternalDatabaseConnectionService","type":"METHOD","content":{"title":"Update an external database connection","request":"curl -X PUT \\\n'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n-d '{\n \"externalDatabaseConnection\": {\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\",\n \"tenantId\":\"my-wix-site-updated\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n }\n }\n}'","response":"{\n \"externalDatabaseConnection\": {\n \"name\":\"MyExternalDatabase\",\n \"endpoint\":\"https://example.com/my-external-database\",\n \"configuration\":{\n \"secretKey\":\"2b723306-4d74-42a2-8438-2ff40da3e6b6\",\n \"tenantId\":\"my-wix-site-updated\",\n \"environment\":\"PRODUCTION\",\n \"collections\":[\n \"products\",\n \"categories\"\n ]\n },\n \"connectionStatus\": {"}}],"sourceRepo":"git@github.com:wix-private/cloud.git","contentLink":{"displayName":"Update External Database Connection","slugifiedName":"update-external-database-connection"}}],"webhooks":[{"summary":"External Database Connection Created","title":"External Database Connection Created","description":"Triggered when an external database connection is created.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"eventType":"wix.data.v1.external_database_connection_created","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","contentLink":{"displayName":"External Database Connection Created","slugifiedName":"external-database-connection-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"External Database Connection Updated","title":"External Database Connection Updated","description":"Triggered when an external database connection is updated.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"eventType":"wix.data.v1.external_database_connection_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","contentLink":{"displayName":"External Database Connection Updated","slugifiedName":"external-database-connection-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"External Database Connection Deleted","title":"External Database Connection Deleted","description":"Triggered when an external database connection is deleted.","permissions":["WIX_DATA.GET_EXTERNAL_DATABASE_CONNECTION"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.data.v1.external_database_connection","serviceName":"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnectionService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage External Database Connections","scopeId":"SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE"}],"eventType":"wix.data.v1.external_database_connection_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cloud.git","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","contentLink":{"displayName":"External Database Connection Deleted","slugifiedName":"external-database-connection-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the External Database Connections API\n\nThe External Database Connections API enables you to connect an external database to the Wix site on which your app is installed.\n\n## Internal vs. external databases\n\nWix provides a comprehensive full-stack platform with integrated database capabilities. Your app can use the [Data Collections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c54f4e4c-34cf-4541-9844-04cd84f5662e*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) to create, modify, and delete data collections in a Wix site on which it is installed. The app can then use the [Data Items API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items) to access and manage data within those collections.\n\nWix's database capabilities cover a wide range of use cases for apps that need to store data. However, certain projects have very specific requirements that make it necessary to use an external database. For example, you may need to access existing data that is already stored on an external service, or you may need your data to be stored in a relational database.\n\nOnce the connection between an external database and a Wix site is established, your app can access the collection using Wix Data APIs, including the [Data Items API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items), in the same way you would with a native collection. The owner of the Wix site on which your app is installed can also access the collection through the Content Management System(CMS) and with [Velo](fallback::https://www.wix.com/velo/reference/wix-data), use the collection to create dynamic pages, and connect the collection to user input elements.\n\nFor more information on connecting external databases with a Wix site, see [Integrating External Databases with Your Wix Site](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site).\n\n## Preparing an external database\n\nBefore the External Database Connections API can connect a Wix site with an external database, you need to prepare the external database by creating an [external database adaptor](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site#what-is-an-external-database-adaptor).\n\nAn external database adaptor is a server that translates Wix data requests from a Wix site or app into an external database's protocol, and translates the response back into a format that Wix APIs can read. This enables Wix APIs, apps, and sites to treat the external database exactly as if it was an internal data collection.\n\nIf your database is hosted on one of the major cloud platforms, you can consult one of our tutorials for instructions on how to [deploy an external database adaptor](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site#deploy-an-external-database-adaptor).\n\nOtherwise, for details on the required specifications for an external database adaptor, see the [External Database Collections service plugin](fallback::https://www.wix.com/velo/reference/spis/external-database-collections).\n\n## Ensuring read-write access\n\nIf you want to enable read-write access to your external database using the [Data Items API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items), ensure your external database's table or schema includes the following fields:\n* `_id`\n* `_createdDate`\n* `_updatedDate`\n* `_owner`\nIf these fields are absent, access to the external database is read-only. You may prefer this option for data that your app only needs to retrieve and doesn't need to manage.\n\n## Supported databases\nThe External Database Connections API works with several kinds of databases. For a full list, see [Supported Databases](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site#supported-databases).\n","sourceRepo":"git@github.com:wix-private/cloud.git","path":"docs/ExternalDatabaseConnections.md"}],"components":{"schemas":{"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection":{"type":"object","properties":{"name":{"description":"Name of the external database connection.\nAn external database connection may connect to one or more external data collections or tables.\nThese are represented as `connectionName/dataCollectionId`.","immutable":true,"minLength":1,"maxLength":255,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"endpoint":{"description":"Base URL for provisioning and managing data in the external database. For example: `https://example.com/my-external-database`.","format":"WEB_URL","title":"endpoint","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"configuration":{"description":"Settings passed to the external database connection as part of each request.\nThese settings can relate to authentication, tenancy, or provide any other information needed for processing a request.\nTheir content and structure depend on the specific requirements of the external database's API.","title":"configuration","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"connectionStatus":{"description":"Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ConnectionStatus","summary":"connectionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"capabilities":{"description":"The external database's capabilities.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.Capabilities","summary":"capabilities","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExternalDatabaseConnection","description":"An external database connection defines a connection between an external database and a Wix site or project."},"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ConnectionStatus.CauseOfFailure":{"type":"string","description":"","title":"CauseOfFailure","enum":["NONE","COMMUNICATION_FAILURE","DESTINATION_HOST_UNREACHABLE","UNAUTHORIZED","DESTINATION_ENDPOINT_NOT_DEFINED"]},"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ConnectionStatus.CollectionsFound":{"type":"string","description":"","title":"CollectionsFound","enum":["UNKNOWN","YES","NO"]},"com.wixpress.cloud.data.api.FieldType":{"type":"string","description":"","title":"FieldType","enum":["UNKNOWN_FIELD_TYPE","TEXT","NUMBER","DATE","DATETIME","IMAGE","BOOLEAN","DOCUMENT","URL","RICH_TEXT","VIDEO","ANY","ARRAY_STRING","ARRAY_DOCUMENT","AUDIO","TIME","LANGUAGE","RICH_CONTENT","MEDIA_GALLERY","ADDRESS","PAGE_LINK","REFERENCE","MULTI_REFERENCE","OBJECT","ARRAY","LEGACY_TIME","LEGACY_BOOK","LEGACY_EXTERNAL_URL","LEGACY_BROKEN_REFERENCE","LEGACY_IMAGE","LEGACY_COLOR","LEGACY_EXTERNAL_VIDEO"]},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ConnectionStatus":{"type":"object","properties":{"successful":{"description":"Whether the connection was established successfully.","title":"successful","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"causeOfFailure":{"description":"If and why a connection attempt failed.\n+ `NONE`: No connection failure.\n+ `COMMUNICATION_FAILURE`: General communication failure.\n+ `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.\n+ `UNAUTHORIZED`: Unauthorized to access external database.\n+ `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.","title":"causeOfFailure","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ConnectionStatus.CauseOfFailure","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasCollections":{"description":"Whether the external database has existing collections. Possible values are:\n+ `UNKNOWN`: The attempt to connect to the external database failed, so status is unknown.\n+ `NO`: External database does not have any existing collections.\n+ `YES`: External database has existing collections.","readOnly":true,"title":"hasCollections","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ConnectionStatus.CollectionsFound","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConnectionStatus","description":""},"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.ProtocolVersion":{"type":"string","description":"","title":"ProtocolVersion","enum":["UNKNOWN_PROTOCOL_VERSION","V1","V2","V3"]},"com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection.Capabilities":{"type":"object","properties":{"collectionModificationsSupported":{"description":"Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them.","title":"collectionModificationsSupported","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldTypes":{"description":"Field types the external database supports.\nThis field only applies when `collectionModificationsSupported` is `true`.","title":"fieldTypes","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.FieldType"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Capabilities","description":""},"com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionRequest":{"type":"object","properties":{"name":{"description":"Name of the external database connection to retrieve.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetExternalDatabaseConnectionRequest","description":""},"com.wixpress.cloud.data.api.externaldatabase.GetExternalDatabaseConnectionResponse":{"type":"object","properties":{"externalDatabaseConnection":{"description":"Details of the external database connection requested.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetExternalDatabaseConnectionResponse","description":""},"com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsRequest":{"type":"object","properties":{"paging":{"description":"Paging","$ref":"#/components/schemas/upstream.externaldatabase.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListExternalDatabaseConnectionsRequest","description":""},"upstream.externaldatabase.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.cloud.data.api.externaldatabase.ListExternalDatabaseConnectionsResponse":{"type":"object","properties":{"externalDatabaseConnections":{"description":"List of external database connections.","title":"externalDatabaseConnections","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata","$ref":"#/components/schemas/upstream.externaldatabase.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListExternalDatabaseConnectionsResponse","description":""},"upstream.externaldatabase.wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionRequest":{"type":"object","properties":{"externalDatabaseConnection":{"description":"External database connection details.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"connectionType":{"description":"Connection type.","title":"connectionType","type":"string","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ConnectionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateExternalDatabaseConnectionRequest","description":""},"com.wixpress.cloud.data.api.externaldatabase.ConnectionType":{"type":"string","description":"","title":"ConnectionType","enum":["UNKNOWN_CONNECTION_TYPE","STANDALONE","WIX_SPI"]},"com.wixpress.cloud.data.api.externaldatabase.CreateExternalDatabaseConnectionResponse":{"type":"object","properties":{"externalDatabaseConnection":{"description":"Details of external database connection created.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateExternalDatabaseConnectionResponse","description":""},"com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionRequest":{"type":"object","properties":{"externalDatabaseConnection":{"description":"Updated external database connection details. The existing connection is replaced with this version.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExternalDatabaseConnectionRequest","description":""},"com.wixpress.cloud.data.api.externaldatabase.UpdateExternalDatabaseConnectionResponse":{"type":"object","properties":{"externalDatabaseConnection":{"description":"Updated external database connection details.","$ref":"#/components/schemas/com.wixpress.cloud.data.api.externaldatabase.ExternalDatabaseConnection","summary":"externalDatabaseConnection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExternalDatabaseConnectionResponse","description":""},"com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionRequest":{"type":"object","properties":{"name":{"description":"Name of the external database connection to delete.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteExternalDatabaseConnectionRequest","description":""},"com.wixpress.cloud.data.api.externaldatabase.DeleteExternalDatabaseConnectionResponse":{"type":"object","properties":{},"title":"DeleteExternalDatabaseConnectionResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"External Database Connection","description":"An external database connection defines a connection between an external database and a Wix site or project.","fqdn":"wix.data.v1.external_database_connection"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the External Database Connections API\n\nThe External Database Connections API enables you to connect an external database to the Wix site on which your app is installed.\n\n## Internal vs. external databases\n\nWix provides a comprehensive full-stack platform with integrated database capabilities. Your app can use the [Data Collections API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c54f4e4c-34cf-4541-9844-04cd84f5662e*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) to create, modify, and delete data collections in a Wix site on which it is installed. The app can then use the [Data Items API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items) to access and manage data within those collections.\n\nWix's database capabilities cover a wide range of use cases for apps that need to store data. However, certain projects have very specific requirements that make it necessary to use an external database. For example, you may need to access existing data that is already stored on an external service, or you may need your data to be stored in a relational database.\n\nOnce the connection between an external database and a Wix site is established, your app can access the collection using Wix Data APIs, including the [Data Items API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items), in the same way you would with a native collection. The owner of the Wix site on which your app is installed can also access the collection through the Content Management System(CMS) and with [Velo](fallback::https://www.wix.com/velo/reference/wix-data), use the collection to create dynamic pages, and connect the collection to user input elements.\n\nFor more information on connecting external databases with a Wix site, see [Integrating External Databases with Your Wix Site](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site).\n\n## Preparing an external database\n\nBefore the External Database Connections API can connect a Wix site with an external database, you need to prepare the external database by creating an [external database adaptor](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site#what-is-an-external-database-adaptor).\n\nAn external database adaptor is a server that translates Wix data requests from a Wix site or app into an external database's protocol, and translates the response back into a format that Wix APIs can read. This enables Wix APIs, apps, and sites to treat the external database exactly as if it was an internal data collection.\n\nIf your database is hosted on one of the major cloud platforms, you can consult one of our tutorials for instructions on how to [deploy an external database adaptor](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site#deploy-an-external-database-adaptor).\n\nOtherwise, for details on the required specifications for an external database adaptor, see the [External Database Collections service plugin](fallback::https://www.wix.com/velo/reference/spis/external-database-collections).\n\n## Ensuring read-write access\n\nIf you want to enable read-write access to your external database using the [Data Items API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::66a530fa-224c-48ee-841f-99a87365c6c3*fallback::https://dev.wix.com/api/rest/wix-data/wix-data/data-items), ensure your external database's table or schema includes the following fields:\n* `_id`\n* `_createdDate`\n* `_updatedDate`\n* `_owner`\nIf these fields are absent, access to the external database is read-only. You may prefer this option for data that your app only needs to retrieve and doesn't need to manage.\n\n## Supported databases\nThe External Database Connections API works with several kinds of databases. For a full list, see [Supported Databases](fallback::https://support.wix.com/en/article/velo-integrating-external-databases-with-your-wix-site#supported-databases).\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

List External Database Connections

Permission Scopes