Modify an In-Memory DB Instance

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 list to modify an instance: https://in-memory-db.{region}.ionos.com/replicasets/{replicasetId}

Note: Remember to update the replicasetId with a valid UUID. The sample UUID in the example is 498ae72f-411f-11eb-9d07-046c59cc737e.

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"
    }
  }
}'

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
Authorization	yes	string	Provide a header value as Bearer followed by your token.
Content-Type	yes	string	Set this to application/json.

Path Parameters

The following path parameter is mandatory:

Path Parameter	Required	Type	Description
replicasetId	yes	string	The ID (UUID) of the ReplicaSet. Example: 498ae72f-411f-11eb-9d07-046c59cc737e.

Request Body Parameters

Below is the list of mandatory body parameters:

Body Parameters	Type	Description	Example
id	string	The ID (UUID) of the ReplicaSet.	1046e9bf-dbc0-5bd3-9291-713d36ab77e9
displayName	string	The human-readable name of your replica set.	In-Memory DB replica set
version	string	The In-Memory DB version of your replica set.	7.2
replicas	integer	The total number of replicas in the replica set (one active and n-1 passive).	2
resources	object	The resources of the individual replicas.	"cores": 4, "ram": 4
persistenceMode	string	Specifies data persistence mode. The values are: None (default value), AOF, RDB, and RDB_AOF.	RDB
evictionPolicy	string	The eviction policy for the replica set.	The values are: noeviction, allkeys-lru, allkeys-lfu, allkeys-random, volatile-lru, volatile-lfu, volatile-random, and volatile-ttl.
connections	object	The network connection for your replica set. Only one connection is allowed.	{ "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003", "lanId": "2", "cidr": "192.168.1.100/24"}
credentials	object	Credentials for the In-Memory DB replicaset.	"username": "DatabaseAdmin"

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