The In-Memory DB instance will be deployed in about five minutes after the creation of your first instance. For more information about In-Memory DB instance creation, see Create an In-Memory DB Instance.

We recommend you manually verify if the request has successfully created an instance because IONOS does not send notifications upon instance creation. However, you can poll the API to see when the state switches to AVAILABLE. You can use the following command:

while [[ $(curl -sXGET "https://in-memory-db.de-txl.ionos.com/replicasets/${UUID}" -H "Authorization: Bearer ${TOKEN}" | jq -r .metadata.state) != "AVAILABLE" ]]; do
  sleep 5
  clear
  echo -e "Cluster status:\n"
  kg replicasets "${UUID}" -ojsonpath='{.status.conditions}' | yq -P
  echo -e "\ncluster is not available yet, waiting 5 seconds..."
done

Initialize the In-Memory DB Instance

Soon after the In-Memory DB instance is created, you can establish a connection via the In-Memory DB CLI to connect it to the database. For more information, refer to the In-Memory DB documentation.

You can retrieve an In-Memory DB instance using its UUID. It is found in the response body when an In-Memory DB instance is created or when you retrieve a list of In-Memory DB instances using GET.

Endpoint

Use a region-specific endpoint from the following list to fetch an instance:

• https://in-memory-db.de-txl.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.de-fra.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.es-vit.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.gb-lhr.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-ewr.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-las.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-mci.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.fr-par.ionos.com/replicasets/{replicasetId}

Request

To query a single instance, you need the id from your create response.

curl -X 'GET' \
  'https://in-memory-db.de-txl.ionos.com/replicasets/498ae72f-411f-11eb-9d07-046c59cc737e' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer $Token' \

Response

202 Successful operation

{
"id": "498ae72f-411f-11eb-9d07-046c59cc737e",
"type": "replicaset",
"href": "/replicasets/498ae72f-411f-11eb-9d07-046c59cc737e",
"metadata": {
"createdDate": "2020-12-10T13:37:50+01:00",
"createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"lastModifiedDate": "2020-12-11T13:37:50+01:00",
"lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
"state": "AVAILABLE",
"message": "In progress.",
"dnsName": "in-memory-db.example.com"
},
"properties": {
"displayName": "In-Memory DB replica set",
"version": "7.2",
"replicas": 2,
"resources": {},
"persistenceMode": "None",
"evictionPolicy": "allkeys-lru",
"connections": [],
"maintenanceWindow": {},
"credentials": {},
"initialSnapshotId": "12345678-1234-1234-1234-123456789012"
}
}

You may ensure the success of creating an In-Memory DB instance by adhering to the following network and resource requirements.

Network configuration

To set up an instance inside an existing data center, you should have at least one server in a private LAN. You need to choose an IP address for the primary In-Memory DB instance to be available on your LAN within the VDC. It becomes available on the chosen IP address after provisioning.

There is currently no IP address management for In-Memory DB instances. If you use your subnet, you may use any IP address in that corresponding subnet. You must choose the IP address of the subnet that IONOS assigns you if your servers use DHCP. The IP address of the subnet can be found in your NIC configuration.

Resource considerations

CPU, RAM, storage, and the number of In-Memory DB instances are counted against quotas. For more information, see Resource allocation.

The performance of the In-Memory DB instance depends on the type of storage used. IONOS DBaaS selects the appropriate storage capacity based on the RAM size of your In-Memory DB instance and the chosen data persistence setting.

In-Memory DB instance backups

All In-Memory DB instances are backed up automatically. For more information, see Automatic backups.

The request creates a new In-Memory DB instance on IONOS DBaaS. Each In-Memory DB instance can contain multiple nodes.

The data center must be provided as a UUID. The easiest way to retrieve the UUID is through the Cloud API.

Endpoint

Use a region-specific endpoint from the following list to create an In-Memory DB instance:

• https://in-memory-db.de-txl.ionos.com/replicasets

• https://in-memory-db.de-fra.ionos.com/replicasets

• https://in-memory-db.es-vit.ionos.com/replicasets

• https://in-memory-db.gb-lhr.ionos.com/replicasets

• https://in-memory-db.us-ewr.ionos.com/replicasets

• https://in-memory-db.us-las.ionos.com/replicasets

• https://in-memory-db.us-mci.ionos.com/replicasets

• https://in-memory-db.fr-par.ionos.com/replicasets

Request

curl -X 'POST' \
  'https://in-memory-db.de-txl.ionos.com/replicasets' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $Token' \
--data 
'{
   "metadata":{
      
   },
   "properties":{
      "displayName":"In-Memory DB replica set",
      "version":"7.2",
      "replicas":2,
      "resources":{
         "cores":4,
         "ram":4
      },
      "persistence":{
         "mode":"None",
         "minimalSaveInterval":3600
      },
      "evictionPolicy":"allkeys-lru",
      "connections":[
         {
            "datacenterId":"dd00-7a96-dd00-dd00-bcaa13",
            "lanId":"2",
            "cidr":"123.123.1.100/24"
         }
      ],
      "maintenanceWindow":{
         "time":"16:30:59",
         "dayOfTheWeek":"Monday"
      },
      "credentials":{
         "username":"user13",
         "password":"mypassword"
      },
      "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
      }
}'

Response

Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.

You may have noticed that the metadata.state is BUSY and that the instance is not yet reachable. This is because the cloud will create a completely new instance and needs to provision new nodes for all the requested replicas. This process runs asynchronously in the background and might take up to 30 minutes.

202 Successful operation

{
"id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
"type": "replicaset",
"href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
"metadata": {
"createdDate": "2020-12-10T13:37:50+01:00",
"createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"lastModifiedDate": "2020-12-11T13:37:50+01:00",
"lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
"resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
"state": "AVAILABLE",
"message": "In progress.",
"dnsName": "in-memory-db.example.com"
},
"properties": {
"displayName": "In-Memory DB replica set",
"version": "7.2",
"replicas": 2,
"resources": {},
"persistenceMode": "None",
"evictionPolicy": "allkeys-lru",
"connections": [],
"maintenanceWindow": {},
"credentials": {},
"initialSnapshotId": "12345678-1234-1234-1234-123456789012"
}
}

The request creates a new In-Memory DB instance with the ID if the instance does not exist. Otherwise, it updates the existing instance. You can modify an In-Memory DB instance using its UUID found in the response body when an In-Memory DB instance is created or when you retrieve a list of In-Memory DB instances using GET.

Endpoint

Use a region-specific endpoint from the following list to modify an instance:

• https://in-memory-db.de-txl.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.de-fra.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.es-vit.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.gb-lhr.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-ewr.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-las.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-mci.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.fr-par.ionos.com/replicasets/{replicasetId}

Request

To modify a single instance, you need the id from your create response.

curl --location --request PUT 'https://in-memory-db.de-txl.ionos.com/replicasets/498ae72f-411f-11eb-9d07-046c59cc737e' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $Token' \
--data 
'{
"id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {},
  "properties": {
    "displayName": "In-Memory DB replica set",
    "version": "7.2",
    "replicas": 2,
    "resources": {
      "cores": 4,
      "ram": 6
    },
    "persistence": {
      "mode": "None",
      "minimalSaveInterval": 3600
    },
    "evictionPolicy": "allkeys-lru",
    "connections": [
      {
        "datacenterId": "dd00-7a96-dd00-dd00-bcaa13",
        "lanId": "2",
        "cidr": "123.123.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "credentials": {
      "username": "user1",
      "password": "mypassword"
    }
  }
}'

Response

Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.

The metadata.state is BUSY when the instance is not yet reachable. This is because the cloud will create a completely new instance and needs to provision new nodes for all the requested replicas. This process runs asynchronously in the background and might take up to 30 minutes.

The metadata state changes to BUSY to enable the creation of a new In-Memory DB instance and provide new nodes for the requested replicas while the cloud remains unreachable. This process runs in the background and may take up to 30 minutes to complete. It works asynchronously, so you do not have to wait until the process is complete.

202 Successful operation

{
"id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
"metadata": { },
"properties": {
"displayName": "In-Memory DB replica set",
"version": "7.2",
"replicas": 2,
"resources": {},
"persistenceMode": "None",
"evictionPolicy": "allkeys-lru",
"connections": [],
"maintenanceWindow": {},
"credentials": {},
"initialSnapshotId": "12345678-1234-1234-1234-123456789012"
}
}

You can retrieve a list of In-Memory DB instances. The number of results displayed on each page depends on the limit and offset values. While limit limits the number of response elements, offset specifies the starting point within the collection of resource results returned from the server.

Additionally, you can also use a response filter (filter.name) to list only the In-Memory DB instances that contain the specified displayName.

Endpoint

Use a region-specific endpoint from the following list to retrieve all instances:

• https://in-memory-db.de-txl.ionos.com/replicasets

• https://in-memory-db.de-fra.ionos.com/replicasets

• https://in-memory-db.es-vit.ionos.com/replicasets

• https://in-memory-db.gb-lhr.ionos.com/replicasets

• https://in-memory-db.us-ewr.ionos.com/replicasets

• https://in-memory-db.us-las.ionos.com/replicasets

• https://in-memory-db.us-mci.ionos.com/replicasets

• https://in-memory-db.fr-par.ionos.com/replicasets

Request

curl -X 'GET' \
  'https://in-memory-db.de-txl.ionos.com/replicasets' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer $Token' \

Response

202 Successful operation

  {
    "id": "6aaa-3ccc-50dd-bebb-5b0b",
    "type": "collection",
    "href": "/replicasets?limit=100&offset=0",
    "items": [
        {
            "id": "14000000f-2eee-4eee-84fff-ae70",
            "type": "replicasets",
            "href": "/replicasets/14000000f-2eee-4eee-84fff-ae70",
            "metadata": {
                "createdBy": "john.doe@example.com",
                "createdByUserId": "abcd-fd97-4800-2cba",
                "createdDate": "2024-04-23T07:54:31Z",
                "dnsName": "",
                "lastModifiedBy": "john.doe@example.com",
                "lastModifiedByUserId": "abcd-fd97-4800-2cba",
                "lastModifiedDate": "2024-04-23T07:54:31Z",
                "state": "UNKNOWN"
            },
            "properties": {
                "connections": [
                    {
                        "cidr": "123.123.1.100/24",
                        "datacenterId": "dd00-7a96-dd00-dd00-bcaa13",
                        "lanId": "2"
                    }
                ],
                "credentials": {
                    "password": null,
                    "username": "user1"
                },
                "evictionPolicy": "allkeys-lru",
                "maintenanceWindow": {
                    "dayOfTheWeek": "monday",
                    "time": "16:30:00"
                },
                "displayName": "In-Memory DB replica set",
                "persistence": {
                    "minimalSaveInterval": 3600,
                    "mode": "None"
                },
                "version": "7.2",
                "replicas": 2,
                "resources": {
                    "cores": 4,
                    "ram": 4,
                    "storage": 10
                }
            }
        },
        {
            "id": "6000a-300b-4004-9008-6007",
            "type": "replicasets",
            "href": "/replicasets/6000a-300b-4004-9008-6007",
            "metadata": {
                "createdBy": "john.doe@example.com",
                "createdByUserId": "abcd-fd97-4800-2cba",
                "createdDate": "2024-04-22T13:46:25Z",
                "dnsName": "",
                "lastModifiedBy": "john.doe@example.com",
                "lastModifiedByUserId": "abcd-fd97-4800-2cba",
                "lastModifiedDate": "2024-04-22T13:46:25Z",
                "state": "UNKNOWN"
            },
            "properties": {
                "connections": [
                    {
                        "cidr": "123.123.1.100/24",
                        "datacenterId": "dd00-7a96-dd00-dd00-bcaa13",
                        "lanId": "2"
                    }
                ],
                "credentials": {
                    "password": null,
                    "username": "user2"
                },
                "evictionPolicy": "allkeys-lru",
                "maintenanceWindow": {
                    "dayOfTheWeek": "monday",
                    "time": "16:30:00"
                },
                "displayName": "In-Memory DB replica set",
                "persistence": {
                    "minimalSaveInterval": 3600,
                    "mode": "None"
                },
                "version": "7.2",
                "replicas": 2,
                "resources": {
                    "cores": 4,
                    "ram": 4,
                    "storage": 10
                }
            }
        },
    ],
    "offset": 0,
    "limit": 100,
    "_links": {
        "self": "/replicasets?limit=100&offset=0",
        "next": "/replicasets?limit=100&offset=100"
    }
}

You can delete an In-Memory DB instance using its UUID. It is found in the response body when an In-Memory DB instance is created or when you fetch a list of In-Memory DB instances.

Endpoint

Use a region-specific endpoint from the following list to delete an instance:

• https://in-memory-db.de-txl.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.de-fra.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.es-vit.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.gb-lhr.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-ewr.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-las.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.us-mci.ionos.com/replicasets/{replicasetId}

• https://in-memory-db.fr-par.ionos.com/replicasets/{replicasetId}

Request

To delete an In-Memory DB instance, you need the id from your create response.

curl -X 'DELETE' \
  'https://in-memory-db.de-txl.ionos.com/replicasets/498ae72f-411f-11eb-9d07-046c59cc737e' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer $Token' 

Response

Upon successful deletion, you will receive a 202 Accepted response.

Quick Links

Endpoint

A regional endpoint is necessary to interact with the In-Memory DB REST API endpoints. For more information, see the API specification file.

Currently, IONOS supports the following endpoints for various locations:

• Berlin, Germany: https://in-memory-db.de-txl.ionos.com/replicasets

• Frankfurt, Germany: https://in-memory-db.de-fra.ionos.com/replicasets

• Logroño, Spain: https://in-memory-db.es-vit.ionos.com/replicasets

• London, Great Britain: https://in-memory-db.gb-lhr.ionos.com/replicasets

• Newark, United States: https://in-memory-db.us-ewr.ionos.com/replicasets

• Las Vegas, United States: https://in-memory-db.us-las.ionos.com/replicasets

• Lenexa, United States: https://in-memory-db.us-mci.ionos.com/replicasets

• Paris, France: https://in-memory-db.fr-par.ionos.com/replicasets

Examples

The documentation contains curl examples, as the tool is available on Windows 10, Linux, and macOS. You can also refer to the following blog posts on the IONOS website that describe how to execute curl in Linux and Windows systems if you encounter any problems.

The request creates a new restore. You must provide a full restore to create the object.

Endpoint

Use a region-specific endpoint from the following list to create a new restore:

• https://in-memory-db.de-txl.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.de-fra.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.es-vit.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.gb-lhr.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.us-ewr.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.us-las.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.us-mci.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.fr-par.ionos.com/snapshots/{snapshotId}/restores

Request

Response

Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.

202 Successful operation

You can retrieve an In-Memory DB restore using the UUID of its snapshot and restore. It is found in the response body when an In-Memory DB restore is created or when you retrieve a list of In-Memory DB restores using GET.

Endpoint

Use a region-specific endpoint from the following list to retrieve an In-Memory DB restore:

• https://in-memory-db.de-txl.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.de-fra.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.es-vit.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.gb-lhr.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.us-ewr.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.us-las.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.us-mci.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

• https://in-memory-db.fr-par.ionos.com/snapshots/{snapshotId}/restores/{restoreId}

Request

To retrieve a single In-Memory DB restore, you need the id from your create response.

Response

Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.

202 Successful operation

You can retrieve a list of In-Memory DB snapshots. The number of results displayed on each page depends on the limit and offset values. While limit limits the number of response elements, offset specifies the starting point within the collection of resource results returned from the server.

Additionally, you can also use a response filter (filter.name) to list only the In-Memory DB snapshots that contain the specified displayName.

Endpoint

Use a region-specific endpoint from the following list to retrieve all In-Memory DB snapshots:

• https://in-memory-db.de-txl.ionos.com/snapshots

• https://in-memory-db.de-fra.ionos.com/snapshots

• https://in-memory-db.es-vit.ionos.com/snapshots

• https://in-memory-db.gb-lhr.ionos.com/snapshots

• https://in-memory-db.us-ewr.ionos.com/snapshots

• https://in-memory-db.us-las.ionos.com/snapshots

• https://in-memory-db.us-mci.ionos.com/snapshots

• https://in-memory-db.fr-par.ionos.com/snapshots

Request

The following is a sample request:

Response

202 Successful operation

You can retrieve a list of In-Memory DB restores. The number of results displayed on each page depends on the limit and offset values. While limit limits the number of response elements, offset specifies the starting point within the collection of resource results returned from the server.

Additionally, you can also use a response filter (filter.name) to list only the In-Memory DB restores that contain the specified displayName.

Endpoint

Use a region-specific endpoint from the following list to retrieve a list of restores:

• https://in-memory-db.de-txl.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.de-fra.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.es-vit.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.gb-lhr.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.us-ewr.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.us-las.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.us-mci.ionos.com/snapshots/{snapshotId}/restores

• https://in-memory-db.fr-par.ionos.com/snapshots/{snapshotId}/restores

Request

Response

Your values will differ from those in the sample code. It may contain different IDs, timestamps etc.

200 Successful operation

You can retrieve an In-Memory DB snapshot using its UUID. It is found in the response body when an In-Memory DB instance is created or when you retrieve a list of In-Memory DB snapshots using GET.

Endpoint

Use a region-specific endpoint from the following list to retrieve an In-Memory DB snapshot:

• https://in-memory-db.de-txl.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.de-fra.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.es-vit.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.gb-lhr.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.us-ewr.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.us-las.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.us-mci.ionos.com/snapshots/{snapshotId}

• https://in-memory-db.fr-par.ionos.com/snapshots/{snapshotId}

Request

To retrieve a single snapshot, you need the id from your create response. Remember to update your UUID. The sample UUID in the example is 498ae72f-411f-11eb-9d07-046c59cc737e.

Response

202 Successful operation

This topic describes connecting to the In-Memory DB instance from your managed Kubernetes cluster.

Prerequisites

Ensure that the following are available before connecting to the In-Memory DB instance:

• A datacenter with the following id: xyz-my-datacenter.

• A private LAN with id 3 using the network 10.1.1.0/24.

• A database connected to LAN 3 with the following IP address: 10.1.1.5/24.

• A Kubernetes cluster with the following id: xyz-my-cluster.

Connect to the In-Memory DB Instance from the cluster

In the following example, DHCP is used to assign IP addresses to node pools. Therefore, the database must be in the same subnet as the DHCP server.

To enable connectivity, follow these steps:

1. Connect node pools to the private LAN, which is connected to the database:

1. Create a pod to test the connectivity. Schedule the pod exclusively for the node pools connected to the additional LAN if you have several node pools.

Alternatively, you can also use the following commands:

1. Create the pod using either of these commands: kubectl run redis-client --rm -it --image=redis -- /bin/bash or kubectl apply -f pod.yaml

2. Attach the pod and test connectivity: