This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates an external database connection.
An external database collection name must be submitted as a path parameter. If an existing external database connection is found with the same name, that connection's details are updated. If no external database connection has that name, the request fails.
Note: After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.
You can only call this method when authenticated as a Wix app or Wix user identity.
Name of the external database connection.
An external database connection may connect to one or more external data collections or tables.
These are represented as connectionName/dataCollectionId.
Updated external database connection details. The existing connection is replaced with this version.
Updated external database connection details.
curl -X PUT \
'https://www.wixapis.com/wix-data/v1/external-database-connections/MyExternalDatabase' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"externalDatabaseConnection": {
"endpoint":"https://example.com/my-external-database",
"configuration":{
"secretKey":"2b723306-4d74-42a2-8438-2ff40da3e6b6",
"tenantId":"my-wix-site-updated",
"environment":"PRODUCTION",
"collections":[
"products",
"categories"
]
}
}
}'{
"externalDatabaseConnection": {
"name":"MyExternalDatabase",
"endpoint":"https://example.com/my-external-database",
"configuration":{
"secretKey":"2b723306-4d74-42a2-8438-2ff40da3e6b6",
"tenantId":"my-wix-site-updated",
"environment":"PRODUCTION",
"collections":[
"products",
"categories"
]
},
"connectionStatus": {This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.