How to connect to the OpenSearch API using WHMCS service details

Skip to main content
Print

How to connect to the OpenSearch API using WHMCS service details

Find the OpenSearch API endpoint and credential in PD DigitalOcean OpenSearch, then configure an HTTPS client for the intended service. The API endpoint and the Dashboards address serve different purposes.

Open the connection window

Open the client service’s Overview page and choose View connection details once the cluster is ready. Enable Client: Connection details on the product. Copy Host, Port and Username for this service; reveal the masked password with Show only when needed.

Use the displayed host and port rather than guessing the usual OpenSearch port. Keep passwords and credential-bearing URLs out of screenshots, public posts and support messages. The DigitalOcean account token is not the credential for an application’s OpenSearch connection.

Configure HTTPS and CA trust

The module’s example makes an authenticated HTTPS cluster-health request. Configure your application’s supported OpenSearch client with the service endpoint, username and password. Use Download CA certificate when offered and configure the client to trust it with hostname verification enabled.

Do not disable TLS or certificate verification to bypass an error. The certificate, host, port and credential must belong to the same intended service. A successful health request establishes a narrower result than successful ingestion, search or application permissions.

Interpret cluster health carefully

OpenSearch health colours describe shard allocation: green means primary and replica shards are assigned; yellow means primary shards are assigned but some replicas are not; red means at least one primary shard is unassigned. They do not establish that the application is querying the right indexes or that its data is complete.

Use the OpenSearch cluster-health reference to interpret the returned state. Do not delete indexes or change replica counts merely to make an unfamiliar status disappear.

Diagnose a connection failure

Check the service state, allowed source IPv4 address, current credentials, endpoint and TLS trust. A Running banner or stored endpoint is not a fresh application test; provider-read failures can leave stored information visible.

Review the error alongside the client software and version. Do not recreate the service or repeatedly reset its password to diagnose an uncertain failure. The module connection window is not an index, user or ingestion administration interface.

See the PD DigitalOcean OpenSearch WHMCS guide for related setup, or explore PD DigitalOcean OpenSearch.

Table of Contents

Get your website online with PD Hosting

UK hosting, domains and support from a real team. From a first site to a full server.

Terms and Conditions  ·  Privacy Policy

PD Hosting is the trading name of Projektif Digital Ltd, registered in England and Wales, company number 12482555.

PD Hosting
Privacy Overview

This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.