# Models

## The ReplicaSetReadList object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ReplicaSetReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of ReplicaSet resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of ReplicaSet resources.","type":"string"},"items":{"description":"The list of ReplicaSet resources.","type":"array","items":{"$ref":"#/components/schemas/ReplicaSetRead"}}}},{"$ref":"#/components/schemas/Pagination"}]},"ReplicaSetRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the ReplicaSet.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["replicaset"]},"href":{"description":"The URL of the ReplicaSet.","type":"string"},"metadata":{"$ref":"#/components/schemas/ReplicaSetMetadata"},"properties":{"$ref":"#/components/schemas/ReplicaSet"}}},"ReplicaSetMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","required":["dnsName"],"properties":{"dnsName":{"$ref":"#/components/schemas/DnsName"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"DnsName":{"type":"string","description":"The DNS name pointing to your replica set. Will be used to connect to the active/standalone instance.\n"},"ReplicaSet":{"description":"Properties with all data needed to create a new In-Memory DB replication.\n","required":["displayName","version","replicas","resources","persistenceMode","evictionPolicy","connections","credentials"],"type":"object","properties":{"displayName":{"type":"string","description":"The human readable name of your replica set."},"version":{"$ref":"#/components/schemas/Version"},"replicas":{"$ref":"#/components/schemas/Replicas"},"resources":{"$ref":"#/components/schemas/Resources"},"persistenceMode":{"$ref":"#/components/schemas/PersistenceMode"},"evictionPolicy":{"$ref":"#/components/schemas/EvictionPolicy"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your replica set. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/User"},"initialSnapshotId":{"type":"string","format":"uuid","description":"The ID of a snapshot to restore the replica set from.\nIf set, the replica set will be created from the snapshot.\n"}}},"Version":{"type":"string","description":"The In-Memory DB version of your replica set."},"Replicas":{"type":"integer","description":"The total number of replicas in the replica set (one active and n-1 passive).\nIn case of a standalone instance, the value is 1. In all other cases, the value is >1.\nThe replicas will not be available as read replicas, they are only standby for a failure\nof the active instance.\n","minimum":1,"maximum":5},"Resources":{"type":"object","description":"The resources of the individual replicas.\n","required":["cores","ram","storage"],"properties":{"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storage":{"type":"integer","description":"The size of the storage in GB.\nThe size is derived from the amount of RAM and the persistence mode\nand is not configurable.\n","readOnly":true}}},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256},"PersistenceMode":{"type":"string","enum":["None","AOF","RDB","RDB_AOF"],"description":"Specifies How and If data is persisted.\n| Mode                          | Description |\n|-------------------------------|-------------|\n| **None**                      | Data is inMemory only and will not be persisted. Useful for cache only applications. |\n| **AOF** (Append Only File)    | AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the In-Memory DB protocol itself. |\n| **RDB**                       | RDB persistence performs snapshots of the current in memory state. |\n| **RDB_AOF**                   | Booth, RDB and AOF persistence are enabled. |\n","default":"None"},"EvictionPolicy":{"type":"string","description":"The eviction policy for the replica set.\nThe default value is `allkeys-lru`.\n| Policy                | Description |\n|-----------------------|-------------|\n| **noeviction**        | No eviction policy is used. In-Memory DB will never remove any data. If the memory limit is reached, an error will be returned on write operations. |\n| **allkeys-lru**       | The least recently used keys will be removed first. |\n| **allkeys-lfu**       | The least frequently used keys will be removed first. |\n| **allkeys-random**    | Random keys will be removed. |\n| **volatile-lru**      | The least recently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-lfu**      | The least frequently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-random**   | Random keys will be removed, but only among keys with the `expire` field set to `true`. |\n| **volatile-ttl**      | The key with the nearest time to live will be removed first, but only among keys with the `expire` field set to `true`. |\n","enum":["noeviction","allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl"],"default":"allkeys-lru"},"Connection":{"description":"Details about the network connection for your instance.","properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your instance.\nNote the following unavailable IP ranges:\n10.210.0.0/16\n10.212.0.0/14\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"MaintenanceWindow":{"description":"A weekly 4 hour-long window, during which maintenance might occur.\n","properties":{"time":{"type":"string","description":"Start of the maintenance window in UTC time."},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BackupProperties":{"description":"Properties configuring the backup of the replicaset.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"User":{"description":"Credentials for the In-Memory DB replicaset.","properties":{"username":{"$ref":"#/components/schemas/Username"},"password":{"oneOf":[{"$ref":"#/components/schemas/PlaintextPassword"},{"$ref":"#/components/schemas/HashedPassword"}]}},"required":["username","password"],"type":"object"},"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"},"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63},"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}},"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The ReplicaSetRead object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ReplicaSetRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the ReplicaSet.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["replicaset"]},"href":{"description":"The URL of the ReplicaSet.","type":"string"},"metadata":{"$ref":"#/components/schemas/ReplicaSetMetadata"},"properties":{"$ref":"#/components/schemas/ReplicaSet"}}},"ReplicaSetMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","required":["dnsName"],"properties":{"dnsName":{"$ref":"#/components/schemas/DnsName"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"DnsName":{"type":"string","description":"The DNS name pointing to your replica set. Will be used to connect to the active/standalone instance.\n"},"ReplicaSet":{"description":"Properties with all data needed to create a new In-Memory DB replication.\n","required":["displayName","version","replicas","resources","persistenceMode","evictionPolicy","connections","credentials"],"type":"object","properties":{"displayName":{"type":"string","description":"The human readable name of your replica set."},"version":{"$ref":"#/components/schemas/Version"},"replicas":{"$ref":"#/components/schemas/Replicas"},"resources":{"$ref":"#/components/schemas/Resources"},"persistenceMode":{"$ref":"#/components/schemas/PersistenceMode"},"evictionPolicy":{"$ref":"#/components/schemas/EvictionPolicy"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your replica set. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/User"},"initialSnapshotId":{"type":"string","format":"uuid","description":"The ID of a snapshot to restore the replica set from.\nIf set, the replica set will be created from the snapshot.\n"}}},"Version":{"type":"string","description":"The In-Memory DB version of your replica set."},"Replicas":{"type":"integer","description":"The total number of replicas in the replica set (one active and n-1 passive).\nIn case of a standalone instance, the value is 1. In all other cases, the value is >1.\nThe replicas will not be available as read replicas, they are only standby for a failure\nof the active instance.\n","minimum":1,"maximum":5},"Resources":{"type":"object","description":"The resources of the individual replicas.\n","required":["cores","ram","storage"],"properties":{"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storage":{"type":"integer","description":"The size of the storage in GB.\nThe size is derived from the amount of RAM and the persistence mode\nand is not configurable.\n","readOnly":true}}},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256},"PersistenceMode":{"type":"string","enum":["None","AOF","RDB","RDB_AOF"],"description":"Specifies How and If data is persisted.\n| Mode                          | Description |\n|-------------------------------|-------------|\n| **None**                      | Data is inMemory only and will not be persisted. Useful for cache only applications. |\n| **AOF** (Append Only File)    | AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the In-Memory DB protocol itself. |\n| **RDB**                       | RDB persistence performs snapshots of the current in memory state. |\n| **RDB_AOF**                   | Booth, RDB and AOF persistence are enabled. |\n","default":"None"},"EvictionPolicy":{"type":"string","description":"The eviction policy for the replica set.\nThe default value is `allkeys-lru`.\n| Policy                | Description |\n|-----------------------|-------------|\n| **noeviction**        | No eviction policy is used. In-Memory DB will never remove any data. If the memory limit is reached, an error will be returned on write operations. |\n| **allkeys-lru**       | The least recently used keys will be removed first. |\n| **allkeys-lfu**       | The least frequently used keys will be removed first. |\n| **allkeys-random**    | Random keys will be removed. |\n| **volatile-lru**      | The least recently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-lfu**      | The least frequently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-random**   | Random keys will be removed, but only among keys with the `expire` field set to `true`. |\n| **volatile-ttl**      | The key with the nearest time to live will be removed first, but only among keys with the `expire` field set to `true`. |\n","enum":["noeviction","allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl"],"default":"allkeys-lru"},"Connection":{"description":"Details about the network connection for your instance.","properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your instance.\nNote the following unavailable IP ranges:\n10.210.0.0/16\n10.212.0.0/14\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"MaintenanceWindow":{"description":"A weekly 4 hour-long window, during which maintenance might occur.\n","properties":{"time":{"type":"string","description":"Start of the maintenance window in UTC time."},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BackupProperties":{"description":"Properties configuring the backup of the replicaset.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"User":{"description":"Credentials for the In-Memory DB replicaset.","properties":{"username":{"$ref":"#/components/schemas/Username"},"password":{"oneOf":[{"$ref":"#/components/schemas/PlaintextPassword"},{"$ref":"#/components/schemas/HashedPassword"}]}},"required":["username","password"],"type":"object"},"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"},"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63},"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}}}}}
```

## The ReplicaSetEnsure object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ReplicaSetEnsure":{"type":"object","required":["id","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the ReplicaSet.","format":"uuid"},"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/ReplicaSet"}}},"ReplicaSet":{"description":"Properties with all data needed to create a new In-Memory DB replication.\n","required":["displayName","version","replicas","resources","persistenceMode","evictionPolicy","connections","credentials"],"type":"object","properties":{"displayName":{"type":"string","description":"The human readable name of your replica set."},"version":{"$ref":"#/components/schemas/Version"},"replicas":{"$ref":"#/components/schemas/Replicas"},"resources":{"$ref":"#/components/schemas/Resources"},"persistenceMode":{"$ref":"#/components/schemas/PersistenceMode"},"evictionPolicy":{"$ref":"#/components/schemas/EvictionPolicy"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your replica set. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/User"},"initialSnapshotId":{"type":"string","format":"uuid","description":"The ID of a snapshot to restore the replica set from.\nIf set, the replica set will be created from the snapshot.\n"}}},"Version":{"type":"string","description":"The In-Memory DB version of your replica set."},"Replicas":{"type":"integer","description":"The total number of replicas in the replica set (one active and n-1 passive).\nIn case of a standalone instance, the value is 1. In all other cases, the value is >1.\nThe replicas will not be available as read replicas, they are only standby for a failure\nof the active instance.\n","minimum":1,"maximum":5},"Resources":{"type":"object","description":"The resources of the individual replicas.\n","required":["cores","ram","storage"],"properties":{"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storage":{"type":"integer","description":"The size of the storage in GB.\nThe size is derived from the amount of RAM and the persistence mode\nand is not configurable.\n","readOnly":true}}},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256},"PersistenceMode":{"type":"string","enum":["None","AOF","RDB","RDB_AOF"],"description":"Specifies How and If data is persisted.\n| Mode                          | Description |\n|-------------------------------|-------------|\n| **None**                      | Data is inMemory only and will not be persisted. Useful for cache only applications. |\n| **AOF** (Append Only File)    | AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the In-Memory DB protocol itself. |\n| **RDB**                       | RDB persistence performs snapshots of the current in memory state. |\n| **RDB_AOF**                   | Booth, RDB and AOF persistence are enabled. |\n","default":"None"},"EvictionPolicy":{"type":"string","description":"The eviction policy for the replica set.\nThe default value is `allkeys-lru`.\n| Policy                | Description |\n|-----------------------|-------------|\n| **noeviction**        | No eviction policy is used. In-Memory DB will never remove any data. If the memory limit is reached, an error will be returned on write operations. |\n| **allkeys-lru**       | The least recently used keys will be removed first. |\n| **allkeys-lfu**       | The least frequently used keys will be removed first. |\n| **allkeys-random**    | Random keys will be removed. |\n| **volatile-lru**      | The least recently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-lfu**      | The least frequently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-random**   | Random keys will be removed, but only among keys with the `expire` field set to `true`. |\n| **volatile-ttl**      | The key with the nearest time to live will be removed first, but only among keys with the `expire` field set to `true`. |\n","enum":["noeviction","allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl"],"default":"allkeys-lru"},"Connection":{"description":"Details about the network connection for your instance.","properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your instance.\nNote the following unavailable IP ranges:\n10.210.0.0/16\n10.212.0.0/14\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"MaintenanceWindow":{"description":"A weekly 4 hour-long window, during which maintenance might occur.\n","properties":{"time":{"type":"string","description":"Start of the maintenance window in UTC time."},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BackupProperties":{"description":"Properties configuring the backup of the replicaset.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"User":{"description":"Credentials for the In-Memory DB replicaset.","properties":{"username":{"$ref":"#/components/schemas/Username"},"password":{"oneOf":[{"$ref":"#/components/schemas/PlaintextPassword"},{"$ref":"#/components/schemas/HashedPassword"}]}},"required":["username","password"],"type":"object"},"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"},"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63},"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}}}}}
```

## The ReplicaSetCreate object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ReplicaSetCreate":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/ReplicaSet"}}},"ReplicaSet":{"description":"Properties with all data needed to create a new In-Memory DB replication.\n","required":["displayName","version","replicas","resources","persistenceMode","evictionPolicy","connections","credentials"],"type":"object","properties":{"displayName":{"type":"string","description":"The human readable name of your replica set."},"version":{"$ref":"#/components/schemas/Version"},"replicas":{"$ref":"#/components/schemas/Replicas"},"resources":{"$ref":"#/components/schemas/Resources"},"persistenceMode":{"$ref":"#/components/schemas/PersistenceMode"},"evictionPolicy":{"$ref":"#/components/schemas/EvictionPolicy"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your replica set. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/User"},"initialSnapshotId":{"type":"string","format":"uuid","description":"The ID of a snapshot to restore the replica set from.\nIf set, the replica set will be created from the snapshot.\n"}}},"Version":{"type":"string","description":"The In-Memory DB version of your replica set."},"Replicas":{"type":"integer","description":"The total number of replicas in the replica set (one active and n-1 passive).\nIn case of a standalone instance, the value is 1. In all other cases, the value is >1.\nThe replicas will not be available as read replicas, they are only standby for a failure\nof the active instance.\n","minimum":1,"maximum":5},"Resources":{"type":"object","description":"The resources of the individual replicas.\n","required":["cores","ram","storage"],"properties":{"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storage":{"type":"integer","description":"The size of the storage in GB.\nThe size is derived from the amount of RAM and the persistence mode\nand is not configurable.\n","readOnly":true}}},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256},"PersistenceMode":{"type":"string","enum":["None","AOF","RDB","RDB_AOF"],"description":"Specifies How and If data is persisted.\n| Mode                          | Description |\n|-------------------------------|-------------|\n| **None**                      | Data is inMemory only and will not be persisted. Useful for cache only applications. |\n| **AOF** (Append Only File)    | AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the In-Memory DB protocol itself. |\n| **RDB**                       | RDB persistence performs snapshots of the current in memory state. |\n| **RDB_AOF**                   | Booth, RDB and AOF persistence are enabled. |\n","default":"None"},"EvictionPolicy":{"type":"string","description":"The eviction policy for the replica set.\nThe default value is `allkeys-lru`.\n| Policy                | Description |\n|-----------------------|-------------|\n| **noeviction**        | No eviction policy is used. In-Memory DB will never remove any data. If the memory limit is reached, an error will be returned on write operations. |\n| **allkeys-lru**       | The least recently used keys will be removed first. |\n| **allkeys-lfu**       | The least frequently used keys will be removed first. |\n| **allkeys-random**    | Random keys will be removed. |\n| **volatile-lru**      | The least recently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-lfu**      | The least frequently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-random**   | Random keys will be removed, but only among keys with the `expire` field set to `true`. |\n| **volatile-ttl**      | The key with the nearest time to live will be removed first, but only among keys with the `expire` field set to `true`. |\n","enum":["noeviction","allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl"],"default":"allkeys-lru"},"Connection":{"description":"Details about the network connection for your instance.","properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your instance.\nNote the following unavailable IP ranges:\n10.210.0.0/16\n10.212.0.0/14\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"MaintenanceWindow":{"description":"A weekly 4 hour-long window, during which maintenance might occur.\n","properties":{"time":{"type":"string","description":"Start of the maintenance window in UTC time."},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BackupProperties":{"description":"Properties configuring the backup of the replicaset.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"User":{"description":"Credentials for the In-Memory DB replicaset.","properties":{"username":{"$ref":"#/components/schemas/Username"},"password":{"oneOf":[{"$ref":"#/components/schemas/PlaintextPassword"},{"$ref":"#/components/schemas/HashedPassword"}]}},"required":["username","password"],"type":"object"},"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"},"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63},"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}}}}}
```

## The ReplicaSet object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ReplicaSet":{"description":"Properties with all data needed to create a new In-Memory DB replication.\n","required":["displayName","version","replicas","resources","persistenceMode","evictionPolicy","connections","credentials"],"type":"object","properties":{"displayName":{"type":"string","description":"The human readable name of your replica set."},"version":{"$ref":"#/components/schemas/Version"},"replicas":{"$ref":"#/components/schemas/Replicas"},"resources":{"$ref":"#/components/schemas/Resources"},"persistenceMode":{"$ref":"#/components/schemas/PersistenceMode"},"evictionPolicy":{"$ref":"#/components/schemas/EvictionPolicy"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your replica set. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/User"},"initialSnapshotId":{"type":"string","format":"uuid","description":"The ID of a snapshot to restore the replica set from.\nIf set, the replica set will be created from the snapshot.\n"}}},"Version":{"type":"string","description":"The In-Memory DB version of your replica set."},"Replicas":{"type":"integer","description":"The total number of replicas in the replica set (one active and n-1 passive).\nIn case of a standalone instance, the value is 1. In all other cases, the value is >1.\nThe replicas will not be available as read replicas, they are only standby for a failure\nof the active instance.\n","minimum":1,"maximum":5},"Resources":{"type":"object","description":"The resources of the individual replicas.\n","required":["cores","ram","storage"],"properties":{"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storage":{"type":"integer","description":"The size of the storage in GB.\nThe size is derived from the amount of RAM and the persistence mode\nand is not configurable.\n","readOnly":true}}},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256},"PersistenceMode":{"type":"string","enum":["None","AOF","RDB","RDB_AOF"],"description":"Specifies How and If data is persisted.\n| Mode                          | Description |\n|-------------------------------|-------------|\n| **None**                      | Data is inMemory only and will not be persisted. Useful for cache only applications. |\n| **AOF** (Append Only File)    | AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the In-Memory DB protocol itself. |\n| **RDB**                       | RDB persistence performs snapshots of the current in memory state. |\n| **RDB_AOF**                   | Booth, RDB and AOF persistence are enabled. |\n","default":"None"},"EvictionPolicy":{"type":"string","description":"The eviction policy for the replica set.\nThe default value is `allkeys-lru`.\n| Policy                | Description |\n|-----------------------|-------------|\n| **noeviction**        | No eviction policy is used. In-Memory DB will never remove any data. If the memory limit is reached, an error will be returned on write operations. |\n| **allkeys-lru**       | The least recently used keys will be removed first. |\n| **allkeys-lfu**       | The least frequently used keys will be removed first. |\n| **allkeys-random**    | Random keys will be removed. |\n| **volatile-lru**      | The least recently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-lfu**      | The least frequently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-random**   | Random keys will be removed, but only among keys with the `expire` field set to `true`. |\n| **volatile-ttl**      | The key with the nearest time to live will be removed first, but only among keys with the `expire` field set to `true`. |\n","enum":["noeviction","allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl"],"default":"allkeys-lru"},"Connection":{"description":"Details about the network connection for your instance.","properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your instance.\nNote the following unavailable IP ranges:\n10.210.0.0/16\n10.212.0.0/14\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"MaintenanceWindow":{"description":"A weekly 4 hour-long window, during which maintenance might occur.\n","properties":{"time":{"type":"string","description":"Start of the maintenance window in UTC time."},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BackupProperties":{"description":"Properties configuring the backup of the replicaset.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"User":{"description":"Credentials for the In-Memory DB replicaset.","properties":{"username":{"$ref":"#/components/schemas/Username"},"password":{"oneOf":[{"$ref":"#/components/schemas/PlaintextPassword"},{"$ref":"#/components/schemas/HashedPassword"}]}},"required":["username","password"],"type":"object"},"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"},"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63},"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}}}}}
```

## The Version object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Version":{"type":"string","description":"The In-Memory DB version of your replica set."}}}}
```

## The Replicas object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Replicas":{"type":"integer","description":"The total number of replicas in the replica set (one active and n-1 passive).\nIn case of a standalone instance, the value is 1. In all other cases, the value is >1.\nThe replicas will not be available as read replicas, they are only standby for a failure\nof the active instance.\n","minimum":1,"maximum":5}}}}
```

## The Resources object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Resources":{"type":"object","description":"The resources of the individual replicas.\n","required":["cores","ram","storage"],"properties":{"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storage":{"type":"integer","description":"The size of the storage in GB.\nThe size is derived from the amount of RAM and the persistence mode\nand is not configurable.\n","readOnly":true}}},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256}}}}
```

## The EvictionPolicy object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"EvictionPolicy":{"type":"string","description":"The eviction policy for the replica set.\nThe default value is `allkeys-lru`.\n| Policy                | Description |\n|-----------------------|-------------|\n| **noeviction**        | No eviction policy is used. In-Memory DB will never remove any data. If the memory limit is reached, an error will be returned on write operations. |\n| **allkeys-lru**       | The least recently used keys will be removed first. |\n| **allkeys-lfu**       | The least frequently used keys will be removed first. |\n| **allkeys-random**    | Random keys will be removed. |\n| **volatile-lru**      | The least recently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-lfu**      | The least frequently used keys will be removed first, but only among keys with the `expire` field set to `true`. |\n| **volatile-random**   | Random keys will be removed, but only among keys with the `expire` field set to `true`. |\n| **volatile-ttl**      | The key with the nearest time to live will be removed first, but only among keys with the `expire` field set to `true`. |\n","enum":["noeviction","allkeys-lru","allkeys-lfu","allkeys-random","volatile-lru","volatile-lfu","volatile-random","volatile-ttl"],"default":"allkeys-lru"}}}}
```

## The PersistenceMode object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"PersistenceMode":{"type":"string","enum":["None","AOF","RDB","RDB_AOF"],"description":"Specifies How and If data is persisted.\n| Mode                          | Description |\n|-------------------------------|-------------|\n| **None**                      | Data is inMemory only and will not be persisted. Useful for cache only applications. |\n| **AOF** (Append Only File)    | AOF persistence logs every write operation received by the server. These operations can then be replayed again at server startup, reconstructing the original dataset. Commands are logged using the same format as the In-Memory DB protocol itself. |\n| **RDB**                       | RDB persistence performs snapshots of the current in memory state. |\n| **RDB_AOF**                   | Booth, RDB and AOF persistence are enabled. |\n","default":"None"}}}}
```

## The User object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"User":{"description":"Credentials for the In-Memory DB replicaset.","properties":{"username":{"$ref":"#/components/schemas/Username"},"password":{"oneOf":[{"$ref":"#/components/schemas/PlaintextPassword"},{"$ref":"#/components/schemas/HashedPassword"}]}},"required":["username","password"],"type":"object"},"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"},"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63},"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}}}}}
```

## The Username object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Username":{"description":"The username for the initial In-Memory DB user. Some system usernames\nare restricted (e.g. `\"admin\"`, `\"standby\"`).\n","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9_]{1,16}$","type":"string"}}}}
```

## The PlaintextPassword object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"PlaintextPassword":{"type":"string","description":"The password for a In-Memory DB user.","writeOnly":true,"minLength":10,"maxLength":63}}}}
```

## The HashedPassword object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"HashedPassword":{"type":"object","description":"The hashed password for a In-Memory DB user.","writeOnly":true,"required":["algorithm","hash"],"properties":{"algorithm":{"type":"string","enum":["SHA-256"]},"hash":{"type":"string","minLength":64,"maxLength":64}}}}}}
```

## The ReplicaSetMetadata object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ReplicaSetMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","required":["dnsName"],"properties":{"dnsName":{"$ref":"#/components/schemas/DnsName"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"DnsName":{"type":"string","description":"The DNS name pointing to your replica set. Will be used to connect to the active/standalone instance.\n"}}}}
```

## The DnsName object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"DnsName":{"type":"string","description":"The DNS name pointing to your replica set. Will be used to connect to the active/standalone instance.\n"}}}}
```

## The SnapshotReadList object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"SnapshotReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of Snapshot resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of Snapshot resources.","type":"string"},"items":{"description":"The list of Snapshot resources.","type":"array","items":{"$ref":"#/components/schemas/SnapshotRead"}}}},{"$ref":"#/components/schemas/Pagination"}]},"SnapshotRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Snapshot.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["snapshot"]},"href":{"description":"The URL of the Snapshot.","type":"string"},"metadata":{"$ref":"#/components/schemas/SnapshotMetadata"},"properties":{"$ref":"#/components/schemas/Snapshot"}}},"SnapshotMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","required":["replicasetId","datacenterId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the In-Memory DB replica set the snapshot is taken from.\n"},"snapshotTime":{"type":"string","format":"date-time","description":"The time the snapshot was dumped from the replica set."},"datacenterId":{"type":"string","format":"uuid","description":"The ID of the datacenter the snapshot was created in.\nPlease mind, that the snapshot is not available in other datacenters.\n"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"Snapshot":{"description":"A point in time snapshot of a In-Memory DB replica set.\n","type":"object"},"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The SnapshotRead object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"SnapshotRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Snapshot.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["snapshot"]},"href":{"description":"The URL of the Snapshot.","type":"string"},"metadata":{"$ref":"#/components/schemas/SnapshotMetadata"},"properties":{"$ref":"#/components/schemas/Snapshot"}}},"SnapshotMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","required":["replicasetId","datacenterId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the In-Memory DB replica set the snapshot is taken from.\n"},"snapshotTime":{"type":"string","format":"date-time","description":"The time the snapshot was dumped from the replica set."},"datacenterId":{"type":"string","format":"uuid","description":"The ID of the datacenter the snapshot was created in.\nPlease mind, that the snapshot is not available in other datacenters.\n"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"Snapshot":{"description":"A point in time snapshot of a In-Memory DB replica set.\n","type":"object"}}}}
```

## The SnapshotEnsure object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"SnapshotEnsure":{"type":"object","required":["id","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Snapshot.","format":"uuid"},"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/Snapshot"}}},"Snapshot":{"description":"A point in time snapshot of a In-Memory DB replica set.\n","type":"object"}}}}
```

## The SnapshotCreate object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"SnapshotCreate":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/Snapshot"}}},"Snapshot":{"description":"A point in time snapshot of a In-Memory DB replica set.\n","type":"object"}}}}
```

## The Snapshot object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Snapshot":{"description":"A point in time snapshot of a In-Memory DB replica set.\n","type":"object"}}}}
```

## The SnapshotMetadata object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"SnapshotMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","required":["replicasetId","datacenterId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the In-Memory DB replica set the snapshot is taken from.\n"},"snapshotTime":{"type":"string","format":"date-time","description":"The time the snapshot was dumped from the replica set."},"datacenterId":{"type":"string","format":"uuid","description":"The ID of the datacenter the snapshot was created in.\nPlease mind, that the snapshot is not available in other datacenters.\n"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}}}}}
```

## The RestoreReadList object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"RestoreReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of Restore resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of Restore resources.","type":"string"},"items":{"description":"The list of Restore resources.","type":"array","items":{"$ref":"#/components/schemas/RestoreRead"}}}},{"$ref":"#/components/schemas/Pagination"}]},"RestoreRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Restore.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["restore"]},"href":{"description":"The URL of the Restore.","type":"string"},"metadata":{"$ref":"#/components/schemas/RestoreMetadata"},"properties":{"$ref":"#/components/schemas/Restore"}}},"RestoreMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","properties":{"restoreTime":{"type":"string","format":"date-time","description":"The time the snapshot was dumped from the replica set."},"restoredSnapshotId":{"type":"string","format":"uuid","description":"The ID of the snapshot that was restored."}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"Restore":{"type":"object","description":"A point in time snapshot of a In-Memory DB replica set.\n","required":["replicasetId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the replica set the restore was applied on."},"displayName":{"type":"string","description":"The human readable name of your snapshot."},"description":{"type":"string","description":"A description of the snapshot."}}},"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The RestoreRead object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"RestoreRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Restore.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["restore"]},"href":{"description":"The URL of the Restore.","type":"string"},"metadata":{"$ref":"#/components/schemas/RestoreMetadata"},"properties":{"$ref":"#/components/schemas/Restore"}}},"RestoreMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","properties":{"restoreTime":{"type":"string","format":"date-time","description":"The time the snapshot was dumped from the replica set."},"restoredSnapshotId":{"type":"string","format":"uuid","description":"The ID of the snapshot that was restored."}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"Restore":{"type":"object","description":"A point in time snapshot of a In-Memory DB replica set.\n","required":["replicasetId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the replica set the restore was applied on."},"displayName":{"type":"string","description":"The human readable name of your snapshot."},"description":{"type":"string","description":"A description of the snapshot."}}}}}}
```

## The RestoreCreate object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"RestoreCreate":{"type":"object","required":["properties"],"properties":{"metadata":{"description":"Metadata","additionalProperties":true},"properties":{"$ref":"#/components/schemas/Restore"}}},"Restore":{"type":"object","description":"A point in time snapshot of a In-Memory DB replica set.\n","required":["replicasetId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the replica set the restore was applied on."},"displayName":{"type":"string","description":"The human readable name of your snapshot."},"description":{"type":"string","description":"A description of the snapshot."}}}}}}
```

## The Restore object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Restore":{"type":"object","description":"A point in time snapshot of a In-Memory DB replica set.\n","required":["replicasetId"],"properties":{"replicasetId":{"type":"string","format":"uuid","description":"The ID of the replica set the restore was applied on."},"displayName":{"type":"string","description":"The human readable name of your snapshot."},"description":{"type":"string","description":"A description of the snapshot."}}}}}}
```

## The RestoreMetadata object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"RestoreMetadata":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","properties":{"restoreTime":{"type":"string","format":"date-time","description":"The time the snapshot was dumped from the replica set."},"restoredSnapshotId":{"type":"string","format":"uuid","description":"The ID of the snapshot that was restored."}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}}}}}
```

## The ResourceState object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"type":"string","enum":["AVAILABLE","BUSY","FAILED","UNKNOWN"]},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}}}}}
```

## The Connection object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Connection":{"description":"Details about the network connection for your instance.","properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your instance.\nNote the following unavailable IP ranges:\n10.210.0.0/16\n10.212.0.0/14\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"}}}}
```

## The BackupProperties object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"BackupProperties":{"description":"Properties configuring the backup of the replicaset.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."}}}}
```

## The BackupLocation object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."}}}}
```

## The Cores object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1,"maximum":31}}}}
```

## The Ram object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4,"maximum":256}}}}
```

## The MaintenanceWindow object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"MaintenanceWindow":{"description":"A weekly 4 hour-long window, during which maintenance might occur.\n","properties":{"time":{"type":"string","description":"Start of the maintenance window in UTC time."},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}}
```

## The DayOfTheWeek object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Error":{"description":"The Error object is used to represent an error response from the API.\n","type":"object","properties":{"httpStatus":{"type":"integer","description":"The HTTP status code of the operation."},"messages":{"type":"array","description":"A list of error messages.\n","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Application internal error code\n"},"message":{"type":"string","description":"A human readable explanation specific to this occurrence of the\nproblem.\n"}}}}}}}}}
```

## The Metadata object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}}}}}
```

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The Offset object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true}}}}
```

## The Limit object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true}}}}
```

## The Links object

```json
{"openapi":"3.0.3","info":{"title":"In-Memory DB API","version":"1.0.0"},"components":{"schemas":{"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```