> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListExternalDatabaseConnections # Package: externalDatabases # Namespace: ExternalDatabaseConnectionService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/cms/external-databases/external-database-connection/list-external-database-connections.md ## Permission Scopes: Manage External Database Connections: SCOPE.DC-DATA.EXTERNAL-DATABASE-CONNECTIONS-MANAGE ## Introduction Lists all of the site's external database connections of all adaptor types. --- ## REST API ### Schema ``` Method: listExternalDatabaseConnections Description: Lists all of the site's external database connections of all adaptor types. URL: https://www.wixapis.com/wix-data/v1/external-database-connections Method: GET Method parameters: param name: paging | type: Paging - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. Return type: ListExternalDatabaseConnectionsResponse - name: externalDatabaseConnections | type: array | description: List of external database connections. - name: name | type: string | description: Name of the external database connection. An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`. - name: endpoint | type: string | description: Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`. Required for STANDALONE connection type. - name: configuration | type: object | description: Settings specified to the external database connection as part of each request. These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API. - name: connectionStatus | type: ConnectionStatus | description: Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure. - name: successful | type: boolean | description: Whether the connection was established successfully. - name: causeOfFailure | type: CauseOfFailure | description: Whether and why the connection attempt failed. - enum: - NONE: No connection failure. - COMMUNICATION_FAILURE: General communication failure. - DESTINATION_HOST_UNREACHABLE: External database host is unreachable. - UNAUTHORIZED: Unauthorized to access the external database. - DESTINATION_ENDPOINT_NOT_DEFINED: `endpoint` is not set. - name: hasCollections | type: CollectionsFound | description: Whether the external database has collections. - enum: - UNKNOWN: Attempt to connect to the external database failed, so status is unknown. - YES: External database has collections. - NO: External database does not have any collections. - name: publicKey | type: string | description: Public key used to validate requests to the external database. - name: capabilities | type: Capabilities | description: Capabilities of the external database. - name: collectionModificationsSupported | type: boolean | description: Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. - name: fieldTypes | type: array | description: Field types the external database supports. Applies only when `collectionModificationsSupported` is set to `true`. - enum: 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 - name: pagingMetadata | type: PagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. ``` ### Examples ### List all external database connections ```curl curl -X GET \ 'https://www.wixapis.com/wix-data/v1/external-database-connections' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.externalDatabases.ExternalDatabaseConnectionService.listExternalDatabaseConnections(options) Description: Lists all of the site's external database connections of all adaptor types. Method parameters: param name: options | type: ListExternalDatabaseConnectionsOptions none - name: paging | type: Paging | description: Paging metadata. - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. Return type: PROMISE - name: externalDatabaseConnections | type: array | description: List of external database connections. - name: name | type: string | description: Name of the external database connection. An external database connection can connect to one or more external data collections or tables. These appear as `connectionName/dataCollectionId`. - name: endpoint | type: string | description: Base URL for accessing and managing data in the external database. For example: `https://example.com/my-external-database`. Required for STANDALONE connection type. - name: configuration | type: object | description: Settings specified to the external database connection as part of each request. These settings can relate to authentication, tenancy, or provide any other information necessary for processing a request. Their content and structure depend on the specific requirements of the external database's API. - name: connectionStatus | type: ConnectionStatus | description: Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure. - name: successful | type: boolean | description: Whether the connection was established successfully. - name: causeOfFailure | type: CauseOfFailure | description: Whether and why the connection attempt failed. - enum: - NONE: No connection failure. - COMMUNICATION_FAILURE: General communication failure. - DESTINATION_HOST_UNREACHABLE: External database host is unreachable. - UNAUTHORIZED: Unauthorized to access the external database. - DESTINATION_ENDPOINT_NOT_DEFINED: `endpoint` is not set. - name: hasCollections | type: CollectionsFound | description: Whether the external database has collections. - enum: - UNKNOWN: Attempt to connect to the external database failed, so status is unknown. - YES: External database has collections. - NO: External database does not have any collections. - name: publicKey | type: string | description: Public key used to validate requests to the external database. - name: capabilities | type: Capabilities | description: Capabilities of the external database. - name: collectionModificationsSupported | type: boolean | description: Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. - name: fieldTypes | type: array | description: Field types the external database supports. Applies only when `collectionModificationsSupported` is set to `true`. - enum: 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 - name: pagingMetadata | type: PagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. ``` ### Examples ### listExternalDatabaseConnections ```javascript import { externalDatabaseConnections } from '@wix/data'; async function listExternalDatabaseConnections(options) { const response = await externalDatabaseConnections.listExternalDatabaseConnections(options); }; ``` ### listExternalDatabaseConnections (with elevated permissions) ```javascript import { externalDatabaseConnections } from '@wix/data'; import { auth } from '@wix/essentials'; async function myListExternalDatabaseConnectionsMethod(options) { const elevatedListExternalDatabaseConnections = auth.elevate(externalDatabaseConnections.listExternalDatabaseConnections); const response = await elevatedListExternalDatabaseConnections(options); } ``` ### listExternalDatabaseConnections (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { externalDatabaseConnections } from '@wix/data'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { externalDatabaseConnections }, // Include the auth strategy and host as relevant }); async function listExternalDatabaseConnections(options) { const response = await myWixClient.externalDatabaseConnections.listExternalDatabaseConnections(options); }; ``` ---