> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/api-reference/databases/mongodb/models-1.md).

# Models

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"properties":{"httpStatus":{"type":"integer","description":"The HTTP status code of the operation."},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"}}},"type":"object"},"ErrorMessage":{"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"}},"type":"object"}}}}
```

## The ErrorMessage object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ErrorMessage":{"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"}},"type":"object"}}}}
```

## The APIVersion object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"APIVersion":{"properties":{"name":{"type":"string"},"swaggerUrl":{"type":"string"}},"type":"object"}}}}
```

## The UsersList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"UsersList":{"description":"List of cluster users.","properties":{"type":{"$ref":"#/components/schemas/ResourceType"},"id":{"$ref":"#/components/schemas/ResourceId"},"items":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"User":{"description":"MongoDB database user.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"metadata":{"$ref":"#/components/schemas/UserMetadata"},"properties":{"$ref":"#/components/schemas/UserProperties"}},"type":"object"},"UserMetadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."}}},"UserProperties":{"description":"Mongodb user properties.","required":["username"],"properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The UserProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"UserProperties":{"description":"Mongodb user properties.","required":["username"],"properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The User object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"User":{"description":"MongoDB database user.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"metadata":{"$ref":"#/components/schemas/UserMetadata"},"properties":{"$ref":"#/components/schemas/UserProperties"}},"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"UserMetadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."}}},"UserProperties":{"description":"Mongodb user properties.","required":["username"],"properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The PostUserRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PostUserRequest":{"description":"MongoDB database user post request.","properties":{"metadata":{"$ref":"#/components/schemas/UserMetadata"},"properties":{"$ref":"#/components/schemas/PostUserProperties"}}},"UserMetadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."}}},"PostUserProperties":{"description":"MongoDB database user post request properties.","allOf":[{"$ref":"#/components/schemas/UserProperties"},{"type":"object","required":["password"],"properties":{"password":{"type":"string","writeOnly":true,"minLength":10}}}]},"UserProperties":{"description":"Mongodb user properties.","required":["username"],"properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The PostUserProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PostUserProperties":{"description":"MongoDB database user post request properties.","allOf":[{"$ref":"#/components/schemas/UserProperties"},{"type":"object","required":["password"],"properties":{"password":{"type":"string","writeOnly":true,"minLength":10}}}]},"UserProperties":{"description":"Mongodb user properties.","required":["username"],"properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The PatchUserRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PatchUserRequest":{"description":"MongoDB database user patch request.","properties":{"metadata":{"$ref":"#/components/schemas/UserMetadata"},"properties":{"$ref":"#/components/schemas/PatchUserProperties"}}},"UserMetadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."}}},"PatchUserProperties":{"description":"MongoDB database user patch request properties.","properties":{"password":{"type":"string","writeOnly":true,"minLength":10},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The PatchUserProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PatchUserProperties":{"description":"MongoDB database user patch request properties.","properties":{"password":{"type":"string","writeOnly":true,"minLength":10},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserRoles"}}}},"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The UserRoles object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"UserRoles":{"description":"a list of mongodb user role.","properties":{"role":{"type":"string","enum":["read","readWrite","dbAdmin","clusterMonitor","readAnyDatabase","readWriteAnyDatabase","dbAdminAnyDatabase","enableSharding"]},"database":{"type":"string"}},"type":"object"}}}}
```

## The SnapshotList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"SnapshotList":{"description":"List of snapshots.","allOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ResourceType"},"id":{"$ref":"#/components/schemas/ResourceId"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SnapshotResponse"}}}},{"$ref":"#/components/schemas/DeprecatedPagination"}],"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"SnapshotResponse":{"description":"A database snapshot.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"id":{"$ref":"#/components/schemas/ResourceId"},"properties":{"$ref":"#/components/schemas/SnapshotProperties"}},"type":"object"},"SnapshotProperties":{"description":"Properties of a snapshot.","properties":{"version":{"type":"string","description":"The MongoDB version this backup was created from."},"size":{"type":"integer","description":"The size of the snapshot in Mebibytes."},"creationTime":{"type":"string","format":"date-time","description":"The date the resource was created."}},"type":"object"},"DeprecatedPagination":{"description":"Pagination information in list responses. DEPRECATED because of misspelled _links attribute.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"PaginationOffset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"default":0},"PaginationLimit":{"description":"The limit specified in the request (if none was specified, the default\nlimit is 100).\n","type":"integer","minimum":0,"default":100,"maximum":1000},"PaginationLinks":{"description":"The URLs to navigate the different pages.\n","type":"object","properties":{"prev":{"description":"The URL (with offset and limit parameters) of the previous page; only\npresent if the offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"The URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"The URL (with offset and limit parameters) of the next page; only\npresent if the offset and limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The SnapshotResponse object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"SnapshotResponse":{"description":"A database snapshot.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"id":{"$ref":"#/components/schemas/ResourceId"},"properties":{"$ref":"#/components/schemas/SnapshotProperties"}},"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"SnapshotProperties":{"description":"Properties of a snapshot.","properties":{"version":{"type":"string","description":"The MongoDB version this backup was created from."},"size":{"type":"integer","description":"The size of the snapshot in Mebibytes."},"creationTime":{"type":"string","format":"date-time","description":"The date the resource was created."}},"type":"object"}}}}
```

## The SnapshotProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"SnapshotProperties":{"description":"Properties of a snapshot.","properties":{"version":{"type":"string","description":"The MongoDB version this backup was created from."},"size":{"type":"integer","description":"The size of the snapshot in Mebibytes."},"creationTime":{"type":"string","format":"date-time","description":"The date the resource was created."}},"type":"object"}}}}
```

## The CreateRestoreRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"CreateRestoreRequest":{"description":"The restore request.","properties":{"snapshotId":{"type":"string","description":"The unique ID of the snapshot you want to restore."},"recoveryTargetTime":{"type":"string","format":"date-time","description":"If this value is supplied as ISO 8601 timestamp, the backup will be\nreplayed up until the given timestamp.\n"}},"type":"object"}}}}
```

## The ClusterList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ClusterList":{"description":"List of clusters.","allOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ResourceType"},"id":{"$ref":"#/components/schemas/ResourceId"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ClusterResponse"}}}},{"$ref":"#/components/schemas/DeprecatedPagination"}],"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"ClusterResponse":{"description":"A database cluster.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"id":{"$ref":"#/components/schemas/ResourceId"},"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/ClusterProperties"}},"type":"object"},"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]},"ClusterProperties":{"description":"Properties of a database cluster.","properties":{"type":{"$ref":"#/components/schemas/Type"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"location":{"$ref":"#/components/schemas/Location"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"templateID":{"$ref":"#/components/schemas/TemplateID"},"connectionString":{"$ref":"#/components/schemas/ConnectionString"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"storageType":{"$ref":"#/components/schemas/StorageType"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"DisplayName":{"type":"string","description":"The name of your cluster."},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Location":{"type":"string","description":"The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"ConnectionString":{"type":"string","description":"The connection string for your cluster."},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048},"StorageSize":{"type":"integer","description":"The amount of storage per instance in megabytes.","minimum":2048,"maximum":2097152},"StorageType":{"description":"The storage type used in your cluster.","type":"string","enum":["HDD","SSD Standard","SSD Premium"]},"DeprecatedPagination":{"description":"Pagination information in list responses. DEPRECATED because of misspelled _links attribute.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"PaginationOffset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"default":0},"PaginationLimit":{"description":"The limit specified in the request (if none was specified, the default\nlimit is 100).\n","type":"integer","minimum":0,"default":100,"maximum":1000},"PaginationLinks":{"description":"The URLs to navigate the different pages.\n","type":"object","properties":{"prev":{"description":"The URL (with offset and limit parameters) of the previous page; only\npresent if the offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"The URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"The URL (with offset and limit parameters) of the next page; only\npresent if the offset and limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The ClusterResponse object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ClusterResponse":{"description":"A database cluster.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"id":{"$ref":"#/components/schemas/ResourceId"},"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/ClusterProperties"}},"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]},"ClusterProperties":{"description":"Properties of a database cluster.","properties":{"type":{"$ref":"#/components/schemas/Type"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"location":{"$ref":"#/components/schemas/Location"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"templateID":{"$ref":"#/components/schemas/TemplateID"},"connectionString":{"$ref":"#/components/schemas/ConnectionString"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"storageType":{"$ref":"#/components/schemas/StorageType"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"DisplayName":{"type":"string","description":"The name of your cluster."},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Location":{"type":"string","description":"The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"ConnectionString":{"type":"string","description":"The connection string for your cluster."},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048},"StorageSize":{"type":"integer","description":"The amount of storage per instance in megabytes.","minimum":2048,"maximum":2097152},"StorageType":{"description":"The storage type used in your cluster.","type":"string","enum":["HDD","SSD Standard","SSD Premium"]}}}}
```

## The ResourceType object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]}}}}
```

## The ResourceId object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ResourceId":{"type":"string","description":"The unique ID of the resource."}}}}
```

## The ClusterProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ClusterProperties":{"description":"Properties of a database cluster.","properties":{"type":{"$ref":"#/components/schemas/Type"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"location":{"$ref":"#/components/schemas/Location"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"templateID":{"$ref":"#/components/schemas/TemplateID"},"connectionString":{"$ref":"#/components/schemas/ConnectionString"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"storageType":{"$ref":"#/components/schemas/StorageType"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"DisplayName":{"type":"string","description":"The name of your cluster."},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Location":{"type":"string","description":"The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"ConnectionString":{"type":"string","description":"The connection string for your cluster."},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048},"StorageSize":{"type":"integer","description":"The amount of storage per instance in megabytes.","minimum":2048,"maximum":2097152},"StorageType":{"description":"The storage type used in your cluster.","type":"string","enum":["HDD","SSD Standard","SSD Premium"]}}}}
```

## The BiConnectorProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}}}}}
```

## The DeprecatedPagination object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"DeprecatedPagination":{"description":"Pagination information in list responses. DEPRECATED because of misspelled _links attribute.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"PaginationOffset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"default":0},"PaginationLimit":{"description":"The limit specified in the request (if none was specified, the default\nlimit is 100).\n","type":"integer","minimum":0,"default":100,"maximum":1000},"PaginationLinks":{"description":"The URLs to navigate the different pages.\n","type":"object","properties":{"prev":{"description":"The URL (with offset and limit parameters) of the previous page; only\npresent if the offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"The URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"The URL (with offset and limit parameters) of the next page; only\npresent if the offset and limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Pagination":{"description":"Pagination information in list responses.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"_links":{"$ref":"#/components/schemas/PaginationLinks"}}},"PaginationOffset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"default":0},"PaginationLimit":{"description":"The limit specified in the request (if none was specified, the default\nlimit is 100).\n","type":"integer","minimum":0,"default":100,"maximum":1000},"PaginationLinks":{"description":"The URLs to navigate the different pages.\n","type":"object","properties":{"prev":{"description":"The URL (with offset and limit parameters) of the previous page; only\npresent if the offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"The URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"The URL (with offset and limit parameters) of the next page; only\npresent if the offset and limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The PaginationOffset object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PaginationOffset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"default":0}}}}
```

## The PaginationLimit object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PaginationLimit":{"description":"The limit specified in the request (if none was specified, the default\nlimit is 100).\n","type":"integer","minimum":0,"default":100,"maximum":1000}}}}
```

## The PaginationLinks object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PaginationLinks":{"description":"The URLs to navigate the different pages.\n","type":"object","properties":{"prev":{"description":"The URL (with offset and limit parameters) of the previous page; only\npresent if the offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"The URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"The URL (with offset and limit parameters) of the next page; only\npresent if the offset and limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The CreateClusterRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"CreateClusterRequest":{"description":"The request payload with all data needed to create a new MongoDB cluster.\n","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/CreateClusterProperties"}},"type":"object"},"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]},"CreateClusterProperties":{"description":"The properties with all the data needed to create a new MongoDB cluster.\n","required":["mongoDBVersion","instances","connections","location","displayName"],"properties":{"type":{"$ref":"#/components/schemas/Type"},"templateID":{"$ref":"#/components/schemas/TemplateID"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"location":{"$ref":"#/components/schemas/Location"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"fromBackup":{"$ref":"#/components/schemas/CreateRestoreRequest"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"storageType":{"$ref":"#/components/schemas/StorageType"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"Location":{"type":"string","description":"The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"DisplayName":{"type":"string","description":"The name of your cluster."},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"CreateRestoreRequest":{"description":"The restore request.","properties":{"snapshotId":{"type":"string","description":"The unique ID of the snapshot you want to restore."},"recoveryTargetTime":{"type":"string","format":"date-time","description":"If this value is supplied as ISO 8601 timestamp, the backup will be\nreplayed up until the given timestamp.\n"}},"type":"object"},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048},"StorageSize":{"type":"integer","description":"The amount of storage per instance in megabytes.","minimum":2048,"maximum":2097152},"StorageType":{"description":"The storage type used in your cluster.","type":"string","enum":["HDD","SSD Standard","SSD Premium"]}}}}
```

## The UserMetadata object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"UserMetadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."}}}}}}
```

## The Metadata object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]}}}}
```

## The State object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]}}}}
```

## The Health object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]}}}}
```

## The CreateClusterProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"CreateClusterProperties":{"description":"The properties with all the data needed to create a new MongoDB cluster.\n","required":["mongoDBVersion","instances","connections","location","displayName"],"properties":{"type":{"$ref":"#/components/schemas/Type"},"templateID":{"$ref":"#/components/schemas/TemplateID"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"location":{"$ref":"#/components/schemas/Location"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"fromBackup":{"$ref":"#/components/schemas/CreateRestoreRequest"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"storageType":{"$ref":"#/components/schemas/StorageType"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"Location":{"type":"string","description":"The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"DisplayName":{"type":"string","description":"The name of your cluster."},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"CreateRestoreRequest":{"description":"The restore request.","properties":{"snapshotId":{"type":"string","description":"The unique ID of the snapshot you want to restore."},"recoveryTargetTime":{"type":"string","format":"date-time","description":"If this value is supplied as ISO 8601 timestamp, the backup will be\nreplayed up until the given timestamp.\n"}},"type":"object"},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048},"StorageSize":{"type":"integer","description":"The amount of storage per instance in megabytes.","minimum":2048,"maximum":2097152},"StorageType":{"description":"The storage type used in your cluster.","type":"string","enum":["HDD","SSD Standard","SSD Premium"]}}}}
```

## The PatchClusterRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PatchClusterRequest":{"description":"Request payload to change a cluster.","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/PatchClusterProperties"}},"type":"object"},"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]},"PatchClusterProperties":{"description":"Properties of the payload to change a cluster.","properties":{"type":{"$ref":"#/components/schemas/Type"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"connections":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"templateID":{"$ref":"#/components/schemas/TemplateID"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"DisplayName":{"type":"string","description":"The name of your cluster."},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048}}}}
```

## The PatchClusterProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"PatchClusterProperties":{"description":"Properties of the payload to change a cluster.","properties":{"type":{"$ref":"#/components/schemas/Type"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"instances":{"$ref":"#/components/schemas/Instances"},"shards":{"$ref":"#/components/schemas/Shards"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"biConnector":{"$ref":"#/components/schemas/BiConnectorProperties"},"connections":{"type":"array","minItems":0,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"templateID":{"$ref":"#/components/schemas/TemplateID"},"mongoDBVersion":{"$ref":"#/components/schemas/MongoDBVersion"},"edition":{"$ref":"#/components/schemas/Edition"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"}},"type":"object"},"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"},"DisplayName":{"type":"string","description":"The name of your cluster."},"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"},"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"},"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}},"BiConnectorProperties":{"properties":{"enabled":{"type":"boolean","description":"The MongoDB Connector for Business Intelligence allows you to query a MongoDB database\nusing SQL commands to aid in data analysis.\n","default":false},"host":{"type":"string","description":"The host where this new BI Connector is installed.\n","readOnly":true},"port":{"type":"string","description":"Port number used when connecting to this new BI Connector.\n","readOnly":true}}},"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"},"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."},"Edition":{"type":"string","description":"The cluster edition."},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048}}}}
```

## The TemplateID object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"TemplateID":{"type":"string","description":"The unique ID of the template, which specifies the number of cores, storage size, and memory.\nYou cannot downgrade to a smaller template or minor edition; for example, downgrading from *Business* to *Playground* is not possible.\nTo get a list of all templates to confirm the changes, use the '/templates' endpoint.\n"}}}}
```

## The ClusterLogs object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ClusterLogs":{"description":"The logs of the MongoDB cluster.","properties":{"instances":{"type":"array","items":{"properties":{"name":{"description":"The name of the MongoDB instance.","type":"string"},"messages":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"message":{"type":"string"}}}}},"type":"object"}}},"type":"object"}}}}
```

## The Edition object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Edition":{"type":"string","description":"The cluster edition."}}}}
```

## The Cores object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1}}}}
```

## The Ram object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Ram":{"type":"integer","description":"The amount of memory per instance in megabytes. Has to be a multiple of 1024.","multipleOf":1024,"minimum":2048}}}}
```

## The StorageSize object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"StorageSize":{"type":"integer","description":"The amount of storage per instance in megabytes.","minimum":2048,"maximum":2097152}}}}
```

## The StorageType object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"StorageType":{"description":"The storage type used in your cluster.","type":"string","enum":["HDD","SSD Standard","SSD Premium"]}}}}
```

## The MongoDBVersionList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"MongoDBVersionList":{"description":"List of MongoDB versions.","properties":{"data":{"type":"array","items":{"properties":{"name":{"$ref":"#/components/schemas/MongoDBVersion"}},"type":"object"}}},"type":"object"},"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."}}}}
```

## The MongoDBVersion object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"MongoDBVersion":{"type":"string","description":"The MongoDB version of your cluster."}}}}
```

## The ConnectionString object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"ConnectionString":{"type":"string","description":"The connection string for your cluster."}}}}
```

## The Shards object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Shards":{"type":"integer","description":"The total number of shards in the cluster.\n"}}}}
```

## The Type object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Type":{"type":"string","description":"The cluster type, either `replicaset` or `sharded-cluster`.\n"}}}}
```

## The Instances object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1 secondaries).\n"}}}}
```

## The BackupProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"BackupProperties":{"type":"object","description":"Backup related properties.\n","properties":{"location":{"type":"string","description":"The location where the cluster backups will be stored. If not set, the backup is stored in the nearest location of the cluster.\n"}}}}}}
```

## The Location object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Location":{"type":"string","description":"The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.\n"}}}}
```

## The Connection object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"Connection":{"description":"The network connection  details for your cluster.","properties":{"datacenterId":{"description":"The datacenter to which your cluster will be connected.","type":"string"},"lanId":{"description":"The numeric LAN ID with which you connect your cluster.","type":"string"},"cidrList":{"type":"array","items":{"type":"string"},"description":"The list of IPs for your cluster.\nAll IPs must be in a /24 network.\nNote the following unavailable IP ranges:\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidrList"],"type":"object"}}}}
```

## The DisplayName object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"DisplayName":{"type":"string","description":"The name of your cluster."}}}}
```

## The MaintenanceWindow object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"MaintenanceWindow":{"description":"A weekly window of 4 hours during which maintenance work can be performed.\n","properties":{"time":{"type":"string"},"dayOfTheWeek":{"$ref":"#/components/schemas/DayOfTheWeek"}},"required":["time","dayOfTheWeek"],"type":"object"},"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}}
```

## The DayOfTheWeek object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"DayOfTheWeek":{"description":"The week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}}
```

## The TemplateList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"TemplateList":{"description":"List of MongoDB templates.","allOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ResourceType"},"id":{"$ref":"#/components/schemas/ResourceId"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponse"}}}},{"$ref":"#/components/schemas/DeprecatedPagination"}],"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"TemplateResponse":{"description":"A MongoDB template.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"id":{"$ref":"#/components/schemas/ResourceId"},"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/TemplateProperties"}},"type":"object"},"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]},"TemplateProperties":{"description":"The properties of a MongoDB template.","properties":{"name":{"type":"string","description":"The name of the template."},"edition":{"type":"string","description":"The edition of the template (e.g. enterprise)"},"cores":{"type":"integer","description":"The number of CPU cores."},"ram":{"type":"integer","description":"The amount of memory in MB."},"storageSize":{"type":"integer","description":"The amount of storage size in GB."}}},"DeprecatedPagination":{"description":"Pagination information in list responses. DEPRECATED because of misspelled _links attribute.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"PaginationOffset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"default":0},"PaginationLimit":{"description":"The limit specified in the request (if none was specified, the default\nlimit is 100).\n","type":"integer","minimum":0,"default":100,"maximum":1000},"PaginationLinks":{"description":"The URLs to navigate the different pages.\n","type":"object","properties":{"prev":{"description":"The URL (with offset and limit parameters) of the previous page; only\npresent if the offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"The URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"The URL (with offset and limit parameters) of the next page; only\npresent if the offset and limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The TemplateResponse object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"TemplateResponse":{"description":"A MongoDB template.","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ResourceType"}]},"id":{"$ref":"#/components/schemas/ResourceId"},"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/TemplateProperties"}},"type":"object"},"ResourceType":{"description":"The resource type.","type":"string","enum":["collection","cluster","user","snapshot","template"]},"ResourceId":{"type":"string","description":"The unique ID of the resource."},"Metadata":{"description":"The metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The date the resource was created."},"createdBy":{"type":"string","description":"The user who created the resource."},"createdByUserId":{"type":"string","description":"The ID of the user who created the resource."},"lastModifiedDate":{"type":"string","format":"date-time","description":"The date the resource was last modified."},"lastModifiedBy":{"type":"string","description":"The last user who modified the resource."},"lastModifiedByUserId":{"type":"string","description":"The ID of the user who last modified the resource."},"state":{"$ref":"#/components/schemas/State"},"health":{"$ref":"#/components/schemas/Health"}}},"State":{"description":"The current status reported by the cluster.\n* **AVAILABLE** Resources for this cluster exist and are healthy.\n* **BUSY** Resources for this cluster are being created or updated.\n* **DESTROYING** Delete cluster command was issued, the cluster is being deleted.\n* **FAILED** Failed to get the cluster status.\n* **UNKNOWN** The state is unknown.\n* **UPGRADING** The cluster is upgrading to a different edition.\n","type":"string","enum":["AVAILABLE","BUSY","DESTROYING","FAILED","UNKNOWN","UPGRADING"]},"Health":{"description":"The current health status reported by the cluster.\n* **HEALTHY** Primary exists and number of replicas is equal to specified.\n* **UNHEALTHY** Primary does not exist or cluster doesn't have majority.\n* **DEGRADED** Primary exists and number of replicas is less than specified.\n* **UNKNOWN** The health status is unknown.\n","type":"string","enum":["HEALTHY","UNHEALTHY","DEGRADED","UNKNOWN"]},"TemplateProperties":{"description":"The properties of a MongoDB template.","properties":{"name":{"type":"string","description":"The name of the template."},"edition":{"type":"string","description":"The edition of the template (e.g. enterprise)"},"cores":{"type":"integer","description":"The number of CPU cores."},"ram":{"type":"integer","description":"The amount of memory in MB."},"storageSize":{"type":"integer","description":"The amount of storage size in GB."}}}}}}
```

## The TemplateProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MongoDB REST API","version":"1.0.0"},"components":{"schemas":{"TemplateProperties":{"description":"The properties of a MongoDB template.","properties":{"name":{"type":"string","description":"The name of the template."},"edition":{"type":"string","description":"The edition of the template (e.g. enterprise)"},"cores":{"type":"integer","description":"The number of CPU cores."},"ram":{"type":"integer","description":"The amount of memory in MB."},"storageSize":{"type":"integer","description":"The amount of storage size in GB."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ionos.com/cloud/api-reference/databases/mongodb/models-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.