Enable the BI Connector

This section shows you how to enable the BI Connector on an existing cluster.

Note: This feature is only available for enterprise clusters.

Modify the cluster

The BI Connector is enabled by modifying a cluster attribute with a PATCH request.

• Set biConnector.enabled to true to enable the BI Connector for this cluster.
• You can disable it at any time by setting this attribute to false again.

Note: Only contract administrators and owners can create and change database clusters. In contrast, the running database cluster can be accessed from all servers in the specified LAN.

Endpoint

Use the following endpoint to enable the BI Connector: https://api.ionos.com/databases/mongodb/clusters

Note: The sample cluster UUID is 498ae72f-411f-11eb-9d07-046c59cc737e.

Request

curl --include \
    --request PATCH \
    --user "[e-mail]:Mb2.r5oHf-0t" \
    --header "Content-Type: application/json" \
    --data-binary '{
      "properties": {
        "biConnector": {
          "enabled": true
        }
      }
    }' \

Response

200 Successful operation

• The patched resource is returned.
• The biConnector property now includes the host and port attributes needed to connect to the BI Connector. These are read-only attributes and cannot be changed.
• At this point, you have enabled the BI Connector on your database.

Note: After the BI Connector is enabled, it may take a few minutes until the connector is ready for connections.

{
  "type": "cluster",
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {...},
  "properties": {
    ...
    "biConnector": {
      "enabled": true,
      "host": "r1.m-65f4a879f126e3c4.mongodb.de-fra.ionos.com",
      "port": 27015
    },
    ...
  }
}