For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

You can access the OpenSearch Dashboard in the Control Panel, retrieve cluster and connection fields with the DigitalOcean API or doctl, or call the OpenSearch REST API from curl or application clients. Connection details on the cluster Overview page support each of those paths, including the CA certificate download for HTTPS clients. You can explore logs forwarded from other resources in the OpenSearch Dashboard.

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")

Access OpenSearch Dashboard in the Control Panel

The fastest way to explore indexes, run queries, and work with data (including logs forwarded from other resources) is to open the OpenSearch Dashboard from your cluster in the Control Panel.

1. Go to the Databases page and click your OpenSearch cluster.
2. On the Overview page, click OpenSearch Dashboard.

When the dashboard prompts for credentials, use the same User and password shown in the Connection Details on the Overview page, for example, the default doadmin user or another user you added. Click Show or Copy in that section if you need the password.

To forward logs from other Managed Databases into this cluster, see Forward Logs to OpenSearch Clusters.

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 your connection method:

• Public network and Private network (VPC) options generate connection details based on whether you use the cluster’s public or 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. That username and password are the same credentials you use to sign in to OpenSearch Dashboard in the Control Panel.

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). These details are also what you need for automation and for clients that connect to the cluster over HTTPS.

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 to reveal the password.

Download the CA Certificate

Each managed database comes with a CA certificate you can use to encrypt connections between your client applications and the database.

To download your database’s CA 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 TLS connections.

Connect to the Database

How you use the cluster depends on your needs. A typical workflow is to open the OpenSearch Dashboard from the Control Panel. For automation, retrieve the cluster (and connection details) with doctl or the API. For direct REST access, use curl or an OpenSearch or Elasticsearch client library.

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")

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