updateExternalDatabaseConnection( )


Developer Preview

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 provided in name. 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.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage External Database Connections
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
namestringRequired

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.


externalDatabaseConnectionUpdateExternalDatabaseConnectionRequired

Updated external database connection details. The existing connection is replaced with this version.

Returns
Return Type:Promise<ExternalDatabaseConnection>
Was this helpful?
Yes
No