Adding Databases Programmatically

If you have a lot of Redis databases or you are using RedisInsight as part of some automated workflow, you might want to add databases programmatically.

Now this is possible using our experimental REST API. Below is the documentation for the endpoints required to add databases.

Note that this API should not be considered stable at this point and might change or break entirely in future releases. Do not rely on this API for production.

Add Redis database

Used to add Redis databases to RedisInsight.

URL : /api/instance/

Method : POST

Body Type: JSON

Auth required : NO

Parameters

These are the required parameters for any type of database.

The remaining parameters depend on the connection type.

Standalone database parameters

Standalone databases are added using connectionType: "STANDALONE".

The following additional parameters are required for standalone databases.

Example

{
    "name": "QA Redis DB",
    "connectionType": "STANDALONE",
    "host": "redis.acme.com",
    "port": 6379
}

Redis cluster database parameters

Redis Cluster databases are added using connectionType: "CLUSTER".

The following additional parameters are required for Redis Cluster databases.

Example

{
    "name": "QA Redis Cluster DB",
    "connectionType": "CLUSTER",
    "username": "USERNAME",
    "password": "PASSWORD",
    "seedNodes": [
        {
            "host": "redis-cluster-node-1.acme.com",
            "port": 6379
        }
    ]
}

Sentinel-monitored database parameters

Sentinel-monitored databases are added using connectionType: "SENTINEL".

The following additional parameters are required for standalone databases.

Example

{
    "name": "QA Redis Sentinel DB",
    "connectionType": "SENTINEL",
    "sentinelHost": "redis-sentinel.acme.com",
    "sentinelPort": 26379,
    "sentinelPassword": "sentinel-pass",
    "sentinelMaster": {
        "serviceName": "mymaster",
        "authPass": "opensesame",
    }
}

TLS parameters

TLS parameters can be used to specify how RedisInsight should connect to the Redis database over TLS.

The following parameters can be used:

TLS client certificate and key

The client certificate and key details can be provided in two forms:

1. If the certificate and key has already been used for a database before, or has been added separately, the ID of that certificate can be provided directly.

   Parameter	Type	Description
   id	number	The ID of the client certificate/key pair

2. Alternatively, to create a new client certificate/key pair for the database, a name must be provided along with the certificate and key strings.

   Parameter	Type	Description
   new	object	The details of the new client certificate/key pair to be created
   new.name	string	The name of the new client cert/key pair
   new.cert	string	The client certificate string
   new.key	string	The client private key string

Example

1. Using an existing client certificate/key pair for a new database.

   {
       "name": "Prod Redis Enterprise DB",
       "connectionType": "STANDALONE",
       "host": "redis-ent.acme.com",
       "port": 6379,
       "tls": {
           "useTls": true,
           "clientAuth": true,
           "clientCertificateKeyPair": {
               "id": 6
           }
       }
   }
   

2. Creating a new client certificate/key pair while adding the database.

   {
       "name": "Prod Redis Enterprise DB",
       "connectionType": "STANDALONE",
       "host": "redis-ent.acme.com",
       "port": 6379,
       "tls": {
           "useTls": true,
           "clientAuth": true,
           "clientCertificateKeyPair": {
               "new": {
                   "name": "Prod client certificate",
                   "cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
                   "key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----"
               }
           }
       }
   }
   

TLS CA certificate

The CA certificate details can be provided in two forms:

1. If the certificate has already been used for a database before, the name of that certificate can be provided directly.

   Parameter	Type	Description
   name	string	The name of the CA certificate

2. Alternatively, to create a new CA certificate for the database, a name must be provided along with the certificate string.

   Parameter	Type	Description
   new	object	The details of the new CA certificate to be created
   new.name	string	The name of the new CA cert
   new.cert	string	The CA certificate string

Example

1. Using an existing CA certificate for a new database.

   {
       "name": "Prod Redis Enterprise DB",
       "connectionType": "STANDALONE",
       "host": "redis-ent.acme.com",
       "port": 6379,
       "tls": {
           "useTls": true,
           "caCert": {
               "name": "my-cert"
           }
       }
   }
   

2. Creating a new CA certificate while adding the database.

   {
       "name": "Prod Redis Enterprise DB",
       "connectionType": "STANDALONE",
       "host": "redis-ent.acme.com",
       "port": 6379,
       "tls": {
           "useTls": true,
           "caCert": {
               "new": {
                   "name": "Prod CA certificate",
                   "cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
               }
           }
       }
   }
   

Success response

Code : 201 Created

Add TLS certificate and key pair

Used to add a new TLS certificate and private key pair to use to connect to a Redis database.

URL : /api/tls-client-cert/

Method : POST

Body Type: JSON

Auth required : NO

Parameters

Success response

The name and ID is returned in the response body. The ID can be used to reference this certificate/key pair when adding databases.

Code : 201 Created

Body :

{
    "certificate": {
        "id": 1,
        "name": "VeriCert ACME Certificate"
    }
}

Get added TLS certificate and key pairs

Used to retrieve a list of previously added TLS certificate and private key pair to use to connect to a Redis database.

URL : /api/tls-client-cert/

Method : GET

Auth required : NO

Success response

A list of objects, each containing the client certificate’s name and ID, is returned in the response body. The ID can be used to reference this certificate/key pair when adding databases.

Code : 200 OK

Body :

{
    "certificates": [
        {
            "id": 6,
            "name": "VeriCert ACME Certificate"
        }
    ]
}