How to Connect to OpenSearch Database Clusters

You can connect to DigitalOcean Managed Databases using command line tools and other third-party clients. This guide explains where to find your OpenSearch database’s connection details and how to use them to configure tools and clients.

Retrieve Database Connection Details Using the CLI

Retrieve Database Connection Details Using the API

This API call retrieves the information about your database, including its connection details. The connection details are located in the returned connection JSON object.

curl -X GET \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
  "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30"

import (
    "context"
    "os"

    "github.com/digitalocean/godo"
)

func main() {
    token := os.Getenv("DIGITALOCEAN_TOKEN")

    client := godo.NewFromToken(token)
    ctx := context.TODO()

    cluster, _, err := client.Databases.Get(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30")
}

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.databases.get_cluster(database_cluster_uuid="a7a89a")

View OpenSearch Cluster Connection Details

You use your database’s connection details to configure tools, applications, and resources that connect to the database. To view your database’s connection details, click the name of the cluster on the Databases page to go to its Overview page.

You can view customized connection details based on how you want to connect to the database:

• Public network and Private network (VPC) options generate connection details based on if you want to connect via the cluster’s public hostname or the cluster’s private hostname. Only other resources in the same VPC network as the cluster can access it using its private hostname.

• The User field updates the connection details with the user credentials that you would like to connect with.

You can also choose to view the connection details in different formats:

• Connection parameters: Host, port, and authentication information for application configuration.

• Connection string: A condensed URL that you can pass to a client or use with curl.

OpenSearch exposes a REST API over HTTPS. Use the connection details to build requests to your cluster’s endpoint (for example, https://<your-cluster-hostname>:25060).

By default, the control panel doesn’t reveal the cluster’s password for security reasons. Click Copy to copy connection details with the password, or click show-password to reveal the password.

Download the SSL Certificate

Each managed database comes with an SSL certificate. You can use this SSL certificate to encrypt connections between your client applications and the database.

To download your database’s SSL certificate, click the name of the cluster on the Databases page to go to its Overview page. In the Connection Details section, click Download CA certificate.

When you configure your client applications, you can use the certificate’s location on your local system. Each client application is configured differently, so check the documentation for the tool you’re using for more detail on setting up SSL connections.

Connect to the Database

You can connect to OpenSearch using the command line (for example, curl) or a client that supports the OpenSearch or Elasticsearch API. In this guide, we show you how to connect using curl and how to find connection information for applications.

curl -u doadmin:<your-password> \
  --cacert /path/to/ca-certificate.crt \
  https://<your-cluster-hostname>:25060/_cluster/health?pretty