Getting connection strings

The IBM Cloud® Databases for Redis service is provisioned with authentication enabled. You need a username, password, and connection strings to connect and issue commands.

Connection Strings for your deployment are displayed on the Overview page, in the Endpoints panel. All users on your deployment can use the connection strings, including connection strings for either public or private endpoints.

Your connection string will default to database 0. However, modifying your connection to connect to a database other than 0 is supported.

Your Redis deployment is provisioned with an admin user. You must set the admin password before you can use it to connect to the database. For more information, see the Setting the Admin Password page.

Getting connection strings from the UI

Follow these steps to retrieve your Databases for Redis instance connection strings:

In your deployment's Overview page, scroll down to the Endpoints section.
Within the Endpoints section, you find a Quick start tab with the following sections:
- Connect using a CLI - This section contains information for connecting to your deployment through the IBM CLI.
- Connect using a Redis Client - This section allows you to get a TLS certificate and connect to your deployment.

Getting connection strings from the CLI

You can grab connection strings from the CLI.

ibmcloud cdb deployment-connections example-deployment -u <newusername> [--endpoint-type <endpoint type>]

Full connection information is returned by the ibmcloud cdb deployment-connections command with the --all flag. To retrieve all the connection information for a deployment named "example-deployment", use the following command.

ibmcloud cdb deployment-connections example-deployment -u <newusername> --all [--endpoint-type <endpoint type>]

If you don't specify a user, the deployment-connections commands return information for the admin user by default. If you don't specify an endpoint type, the connection string returns the public endpoint by default. If your deployment has only a private endpoint, you must specify --endpoint-type private or the commands return an error. The user and endpoint type is not enforced. You can use any user on your deployment with either endpoint (if both exist on your deployment).

To use the ibmcloud cdb CLI commands, you must install the Cloud Databases plug-in.

Getting connection strings from the API

To retrieve user's connection strings from the API, use the /users/{userid}/connections endpoint. You must specify in the path which user and which type of endpoint (public or private) is used in the returned connection strings. The user and endpoint type is not enforced. You can use any user on your deployment with either endpoint (if both exist on your deployment).

curl -X GET https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type} \
-H 'Authorization: Bearer <>' \

More users and connection strings

Access to your Databases for Redis deployment is not limited to the admin user. You can create users by using the Service Credentials page, the IBM Cloud CLI, or through the IBM Cloud Databases API.

All users on your deployment can use the connection strings, including connection strings for either public or private endpoints.

Creating users from the UI

Navigate to the resource detail page for your service.
Click Service credentials to open the Service Credentials page.
Click New credential.
Choose a descriptive name for your new credential.
(Optional) Specify whether the new credentials use a public or private endpoint. Use either { "service-endpoints": "public" } / { "service-endpoints": "private" } in the Add Inline Configuration Parameters field to generate connection strings using the specified endpoint. Use of the endpoint is not enforced as it controls which hostnames are in the connection strings. Public endpoints are generated by default.
Click Add to provision the new credentials. A username and password, and an associated Redis user is auto-generated.

The new credentials appear in the table, and the connection strings are available as JSON in a click-to-copy field under View Credentials.

Creating users from the CLI

If you manage your service through the IBM Cloud CLI and the cloud databases plug-in, you can create a new user with cdb user-create. For example, to create a new user for an "example-deployment", use the following command.

ibmcloud cdb user-create example-deployment <newusername> <newpassword>

Once the task has finished, you can retrieve the new user's connection strings with the ibmcloud cdb deployment-connections command.

Creating users with the API

The Foundation Endpoint that is shown on the Overview panel of your service provides the base URL to access this deployment through the API. To create and manage users, use the base URL with the /users endpoint.

curl -X POST 'https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}' \
-H "Authorization: Bearer $APIKEY" \
-H "Content-Type: application/json" \
-d '{"user": {"username": "user", "password": "v3ry-1-secUre-pAssword-2"}}'

To retrieve a user's connection strings, use the base URL with the /users/{userid}/connections endpoint.

Adding users to service credentials in the UI

Creating a new user from the CLI doesn't automatically populate that user's connection strings into Service Credentials. If you want to add them there, you can create a new credential with the existing user information.

Enter the username and password in the JSON field Add Inline Configuration Parameters, or specify a file where the JSON information is stored. For example, putting {"existing_credentials":{"username":"Robert","password":"supersecure"}} in the field generates Service Credentials with the username "Robert" and password "supersecure" filled into connection strings.

Generating credentials from an existing user does not check for or create that user.

Connection String Breakdown

The Redis section

The "Redis" section of a credential created on the Service credentials page contains information that is suited for your applications that make connections to Redis.

Redis/URI connection information
Field name	Index	Description
`Type`		Type of connection - for Redis, it is "URI".
`Scheme`		Scheme for a URI - for Redis, it is "rediss".
`Path`		Path for a URI - for Redis, it is the database number.
`Authentication`	`Username`	The username that you use to connect.
`Authentication`	`Password`	A password for the user - might be shown as `$PASSWORD`.
`Authentication`	`Method`	How authentication takes place; "direct" authentication is handled by the driver.
`Hosts`	`0...`	A hostname and port to connect to.
`Composed`	`0...`	A URI combining Scheme, authentication, host, and path.
`Certificate`	`Name`	The allocated name for the self-signed certificate for database deployment.
`Certificate`	Base64	A base64 encoded version of the certificate.

0... indicates that there might be one or more of these entries in an array.

For more information, see Connecting an external application.

The CLI section

The "CLI" section of a credential created on the Service credentials page contains information that is suited for command-line clients that make connections to Redis.

Redis/cli connection information
Field name	Index	Description
`Bin`		The recommended binary to create a connection; in this case it is `redli`.
`Composed`		A formatted command to establish a connection to your deployment. The command combines the `Bin` executable, `Environment` variable settings and uses `Arguments` as command-line parameters.
`Environment`		A list of keys or values you set as environment variables.
`Arguments`	0...	The information that is passed as arguments to the command shown in the Bin field.
`Certificate`	Base64	A self-signed certificate that is used to confirm that an application is connecting to the appropriate server. It is base64 encoded.
`Certificate`	Name	The allocated name for the self-signed certificate.
`Type`		The type of package that uses this connection information; in this case `cli`.

0... indicates that there might be one or more of these entries in an array.

For more information, see Connecting with a command line client.