# Models

## The ErrorMessage object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.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 ResourceID object

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

## The ResourceHref object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"ResourceHref":{"type":"string","description":"Absolute URL of the resource."}}}}
```

## The MariadbVersion object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]}}}}
```

## The Instances object

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

## The Cores object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.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 MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4}}}}
```

## The StorageSize object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000}}}}
```

## The DisplayName object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"}}}}
```

## The DNSName object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"DNSName":{"type":"string","description":"The DNS name pointing to your cluster."}}}}
```

## The CreateClusterRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"CreateClusterRequest":{"description":"Request payload with all data needed to create a new MariaDB cluster.\n","properties":{"properties":{"$ref":"#/components/schemas/CreateClusterProperties"}},"type":"object"},"CreateClusterProperties":{"description":"Properties with all data needed to create a new MariaDB cluster.\n","required":["mariadbVersion","instances","cores","ram","storageSize","connections","displayName","credentials"],"properties":{"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"instances":{"$ref":"#/components/schemas/Instances"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your cluster. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/DBUser"},"fromBackup":{"$ref":"#/components/schemas/RestoreRequest"}},"type":"object"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"Connection":{"description":"Details about the network connection for your cluster.","properties":{"datacenterId":{"description":"The datacenter to connect your cluster to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your cluster to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your cluster.\nNote the following unavailable IP ranges:\n10.233.64.0/18\n10.233.0.0/18\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 cluster.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"DBUser":{"description":"Credentials for the database user to be created.","properties":{"username":{"$ref":"#/components/schemas/InitialDBUsername"},"password":{"$ref":"#/components/schemas/DBPassword"}},"required":["username","password"],"type":"object"},"InitialDBUsername":{"description":"The username for the initial MariaDB user. Some system usernames\nare restricted (e.g. \"mariadb\", \"admin\", \"standby\").\n\nThe username should be compliant with the following rules:\n- Must not exceed 16 characters\n- Must start with a letter\n- Must contain only letters, numbers, or underscores\n","minLength":1,"maxLength":16,"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9]+_)*[a-zA-Z0-9]+$"},"DBPassword":{"type":"string","description":"The password for a MariaDB user.","writeOnly":true,"minLength":10,"maxLength":63},"RestoreRequest":{"type":"object","required":["backupId"],"description":"Request payload to restore a cluster from a backup.\n","properties":{"backupId":{"$ref":"#/components/schemas/ResourceID"},"recoveryTargetTime":{"type":"string","format":"date-time","description":"The timestamp to which the cluster should be restored.\nIf empty, the backup will be applied to the latest\ntimestamp.\n\nThis value must be supplied as ISO 8601 timestamp, the\nbackup will be replayed up until the given timestamp.\nIf empty, the backup will be applied completely.\n\nMust be within the earliestRecoveryTargetTime and now.\n\nThe earliestRecoveryTargetTime can be looked up in the\nbackup object.\n"}}},"ResourceID":{"type":"string","description":"The unique ID of the resource."}}}}
```

## The CreateClusterProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"CreateClusterProperties":{"description":"Properties with all data needed to create a new MariaDB cluster.\n","required":["mariadbVersion","instances","cores","ram","storageSize","connections","displayName","credentials"],"properties":{"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"instances":{"$ref":"#/components/schemas/Instances"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"description":"The network connection for your cluster. Only one connection is\nallowed.\n","items":{"$ref":"#/components/schemas/Connection"}},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"},"credentials":{"$ref":"#/components/schemas/DBUser"},"fromBackup":{"$ref":"#/components/schemas/RestoreRequest"}},"type":"object"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"Connection":{"description":"Details about the network connection for your cluster.","properties":{"datacenterId":{"description":"The datacenter to connect your cluster to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your cluster to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your cluster.\nNote the following unavailable IP ranges:\n10.233.64.0/18\n10.233.0.0/18\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 cluster.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"DBUser":{"description":"Credentials for the database user to be created.","properties":{"username":{"$ref":"#/components/schemas/InitialDBUsername"},"password":{"$ref":"#/components/schemas/DBPassword"}},"required":["username","password"],"type":"object"},"InitialDBUsername":{"description":"The username for the initial MariaDB user. Some system usernames\nare restricted (e.g. \"mariadb\", \"admin\", \"standby\").\n\nThe username should be compliant with the following rules:\n- Must not exceed 16 characters\n- Must start with a letter\n- Must contain only letters, numbers, or underscores\n","minLength":1,"maxLength":16,"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9]+_)*[a-zA-Z0-9]+$"},"DBPassword":{"type":"string","description":"The password for a MariaDB user.","writeOnly":true,"minLength":10,"maxLength":63},"RestoreRequest":{"type":"object","required":["backupId"],"description":"Request payload to restore a cluster from a backup.\n","properties":{"backupId":{"$ref":"#/components/schemas/ResourceID"},"recoveryTargetTime":{"type":"string","format":"date-time","description":"The timestamp to which the cluster should be restored.\nIf empty, the backup will be applied to the latest\ntimestamp.\n\nThis value must be supplied as ISO 8601 timestamp, the\nbackup will be replayed up until the given timestamp.\nIf empty, the backup will be applied completely.\n\nMust be within the earliestRecoveryTargetTime and now.\n\nThe earliestRecoveryTargetTime can be looked up in the\nbackup object.\n"}}},"ResourceID":{"type":"string","description":"The unique ID of the resource."}}}}
```

## The PatchClusterRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"PatchClusterRequest":{"description":"Request payload to change a cluster.","properties":{"metadata":{"$ref":"#/components/schemas/ClusterMetadata"},"properties":{"$ref":"#/components/schemas/PatchClusterProperties"}},"type":"object"},"ClusterMetadata":{"description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"createdBy":{"type":"string"},"createdByUserId":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp."},"lastModifiedBy":{"type":"string"},"lastModifiedByUserId":{"type":"string"},"state":{"$ref":"#/components/schemas/State"}}},"State":{"description":"The current status reported back by the cluster.","type":"string","enum":["AVAILABLE","BUSY","CREATING","UPDATING","RESTORING","DESTROYING","DEGRADED","FAILED","UNKNOWN"]},"PatchClusterProperties":{"description":"Properties of the payload to change a cluster:\n- instances can only be increased (3, 5, 7),\n- mariadbVersion can only be increased (no downgrade)\n- storageSize can only be increased,\n- ram and cores can be both increased and decreased.\n","properties":{"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"instances":{"$ref":"#/components/schemas/Instances"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"}},"type":"object"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 PatchClusterProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"PatchClusterProperties":{"description":"Properties of the payload to change a cluster:\n- instances can only be increased (3, 5, 7),\n- mariadbVersion can only be increased (no downgrade)\n- storageSize can only be increased,\n- ram and cores can be both increased and decreased.\n","properties":{"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"instances":{"$ref":"#/components/schemas/Instances"},"cores":{"$ref":"#/components/schemas/Cores"},"ram":{"$ref":"#/components/schemas/Ram"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"displayName":{"$ref":"#/components/schemas/DisplayName"},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"}},"type":"object"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 DBUser object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"DBUser":{"description":"Credentials for the database user to be created.","properties":{"username":{"$ref":"#/components/schemas/InitialDBUsername"},"password":{"$ref":"#/components/schemas/DBPassword"}},"required":["username","password"],"type":"object"},"InitialDBUsername":{"description":"The username for the initial MariaDB user. Some system usernames\nare restricted (e.g. \"mariadb\", \"admin\", \"standby\").\n\nThe username should be compliant with the following rules:\n- Must not exceed 16 characters\n- Must start with a letter\n- Must contain only letters, numbers, or underscores\n","minLength":1,"maxLength":16,"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9]+_)*[a-zA-Z0-9]+$"},"DBPassword":{"type":"string","description":"The password for a MariaDB user.","writeOnly":true,"minLength":10,"maxLength":63}}}}
```

## The Connection object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"Connection":{"description":"Details about the network connection for your cluster.","properties":{"datacenterId":{"description":"The datacenter to connect your cluster to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your cluster to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your cluster.\nNote the following unavailable IP ranges:\n10.233.64.0/18\n10.233.0.0/18\n10.233.114.0/24\n"}},"required":["datacenterId","lanId","cidr"],"type":"object"}}}}
```

## The ClusterMetadata object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"ClusterMetadata":{"description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"createdBy":{"type":"string"},"createdByUserId":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp."},"lastModifiedBy":{"type":"string"},"lastModifiedByUserId":{"type":"string"},"state":{"$ref":"#/components/schemas/State"}}},"State":{"description":"The current status reported back by the cluster.","type":"string","enum":["AVAILABLE","BUSY","CREATING","UPDATING","RESTORING","DESTROYING","DEGRADED","FAILED","UNKNOWN"]}}}}
```

## The State object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"State":{"description":"The current status reported back by the cluster.","type":"string","enum":["AVAILABLE","BUSY","CREATING","UPDATING","RESTORING","DESTROYING","DEGRADED","FAILED","UNKNOWN"]}}}}
```

## The ClusterResponse object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"ClusterResponse":{"description":"A database cluster.","properties":{"id":{"$ref":"#/components/schemas/ResourceID"},"metadata":{"$ref":"#/components/schemas/ClusterMetadata"},"properties":{"$ref":"#/components/schemas/ClusterProperties"}},"type":"object"},"ResourceID":{"type":"string","description":"The unique ID of the resource."},"ClusterMetadata":{"description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"createdBy":{"type":"string"},"createdByUserId":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp."},"lastModifiedBy":{"type":"string"},"lastModifiedByUserId":{"type":"string"},"state":{"$ref":"#/components/schemas/State"}}},"State":{"description":"The current status reported back by the cluster.","type":"string","enum":["AVAILABLE","BUSY","CREATING","UPDATING","RESTORING","DESTROYING","DEGRADED","FAILED","UNKNOWN"]},"ClusterProperties":{"description":"Properties of a database cluster.","properties":{"displayName":{"$ref":"#/components/schemas/DisplayName"},"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"dnsName":{"$ref":"#/components/schemas/DNSName"},"instances":{"$ref":"#/components/schemas/Instances"},"ram":{"$ref":"#/components/schemas/Ram"},"cores":{"$ref":"#/components/schemas/Cores"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"}},"type":"object"},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"DNSName":{"type":"string","description":"The DNS name pointing to your cluster."},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"Connection":{"description":"Details about the network connection for your cluster.","properties":{"datacenterId":{"description":"The datacenter to connect your cluster to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your cluster to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your cluster.\nNote the following unavailable IP ranges:\n10.233.64.0/18\n10.233.0.0/18\n10.233.114.0/24\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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 cluster.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."}}}}
```

## The ClusterProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"ClusterProperties":{"description":"Properties of a database cluster.","properties":{"displayName":{"$ref":"#/components/schemas/DisplayName"},"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"dnsName":{"$ref":"#/components/schemas/DNSName"},"instances":{"$ref":"#/components/schemas/Instances"},"ram":{"$ref":"#/components/schemas/Ram"},"cores":{"$ref":"#/components/schemas/Cores"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"}},"type":"object"},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"DNSName":{"type":"string","description":"The DNS name pointing to your cluster."},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"Connection":{"description":"Details about the network connection for your cluster.","properties":{"datacenterId":{"description":"The datacenter to connect your cluster to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your cluster to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your cluster.\nNote the following unavailable IP ranges:\n10.233.64.0/18\n10.233.0.0/18\n10.233.114.0/24\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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 cluster.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."}}}}
```

## The BackupResponse object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"BackupResponse":{"description":"A database backup.","properties":{"id":{"$ref":"#/components/schemas/ResourceID"},"properties":{"$ref":"#/components/schemas/Backup"}},"type":"object"},"ResourceID":{"type":"string","description":"The unique ID of the resource."},"Backup":{"description":"A backup object.","properties":{"clusterId":{"type":"string","description":"The unique ID of the cluster that was backed up."},"location":{"$ref":"#/components/schemas/BackupLocation"},"earliestRecoveryTargetTime":{"type":"string","format":"date-time","description":"The oldest available timestamp to which you can restore."},"size":{"type":"integer","description":"Size of all base backups in MiB. This is at least the sum of\nall base backup sizes.\n"},"baseBackups":{"type":"array","items":{"$ref":"#/components/schemas/BaseBackup"}}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"BaseBackup":{"description":"A single base backup.","properties":{"created":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"size":{"type":"integer","description":"The size of the backup in MiB. This is the\nsize of the binary backup file that was stored.\n"}},"type":"object"}}}}
```

## The Backup object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"Backup":{"description":"A backup object.","properties":{"clusterId":{"type":"string","description":"The unique ID of the cluster that was backed up."},"location":{"$ref":"#/components/schemas/BackupLocation"},"earliestRecoveryTargetTime":{"type":"string","format":"date-time","description":"The oldest available timestamp to which you can restore."},"size":{"type":"integer","description":"Size of all base backups in MiB. This is at least the sum of\nall base backup sizes.\n"},"baseBackups":{"type":"array","items":{"$ref":"#/components/schemas/BaseBackup"}}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"BaseBackup":{"description":"A single base backup.","properties":{"created":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"size":{"type":"integer","description":"The size of the backup in MiB. This is the\nsize of the binary backup file that was stored.\n"}},"type":"object"}}}}
```

## The BaseBackup object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"BaseBackup":{"description":"A single base backup.","properties":{"created":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"size":{"type":"integer","description":"The size of the backup in MiB. This is the\nsize of the binary backup file that was stored.\n"}},"type":"object"}}}}
```

## The MaintenanceWindow object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"DayOfTheWeek":{"description":"The name of the week day.","type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}}
```

## The BackupProperties object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"BackupProperties":{"description":"Properties configuring the backup of the cluster.\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":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."}}}}
```

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"Pagination":{"description":"Pagination information in list responses.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"total":{"$ref":"#/components/schemas/PaginationTotal"},"_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},"PaginationTotal":{"description":"The total number of elements matching the request (without pagination).\n","type":"integer","minimum":0,"default":0},"PaginationLinks":{"description":"URLs to navigate the different pages.\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 PaginationOffset object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.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 MariaDB REST API","version":"0.1.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 PaginationTotal object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"PaginationTotal":{"description":"The total number of elements matching the request (without pagination).\n","type":"integer","minimum":0,"default":0}}}}
```

## The PaginationLinks object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"PaginationLinks":{"description":"URLs to navigate the different pages.\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 ClusterList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"ClusterList":{"description":"List of clusters.","allOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceID"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ClusterResponse"}}}},{"$ref":"#/components/schemas/Pagination"}],"type":"object"},"ResourceID":{"type":"string","description":"The unique ID of the resource."},"ClusterResponse":{"description":"A database cluster.","properties":{"id":{"$ref":"#/components/schemas/ResourceID"},"metadata":{"$ref":"#/components/schemas/ClusterMetadata"},"properties":{"$ref":"#/components/schemas/ClusterProperties"}},"type":"object"},"ClusterMetadata":{"description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"createdBy":{"type":"string"},"createdByUserId":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp."},"lastModifiedBy":{"type":"string"},"lastModifiedByUserId":{"type":"string"},"state":{"$ref":"#/components/schemas/State"}}},"State":{"description":"The current status reported back by the cluster.","type":"string","enum":["AVAILABLE","BUSY","CREATING","UPDATING","RESTORING","DESTROYING","DEGRADED","FAILED","UNKNOWN"]},"ClusterProperties":{"description":"Properties of a database cluster.","properties":{"displayName":{"$ref":"#/components/schemas/DisplayName"},"mariadbVersion":{"$ref":"#/components/schemas/MariadbVersion"},"dnsName":{"$ref":"#/components/schemas/DNSName"},"instances":{"$ref":"#/components/schemas/Instances"},"ram":{"$ref":"#/components/schemas/Ram"},"cores":{"$ref":"#/components/schemas/Cores"},"storageSize":{"$ref":"#/components/schemas/StorageSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Connection"}},"maintenanceWindow":{"$ref":"#/components/schemas/MaintenanceWindow"},"backup":{"$ref":"#/components/schemas/BackupProperties"}},"type":"object"},"DisplayName":{"type":"string","description":"The friendly name of your cluster.","maxLength":63,"pattern":"^(\\w|:|\\-|\\ |.)+$"},"MariadbVersion":{"type":"string","description":"The MariaDB version of your cluster.","enum":["10.6","10.11"]},"DNSName":{"type":"string","description":"The DNS name pointing to your cluster."},"Instances":{"type":"integer","description":"The total number of instances in the cluster (one primary and n-1\nsecondary).\n","minimum":1,"maximum":5},"Ram":{"type":"integer","description":"The amount of memory per instance in gigabytes (GB).","minimum":4},"Cores":{"type":"integer","description":"The number of CPU cores per instance.","minimum":1},"StorageSize":{"type":"integer","description":"The amount of storage per instance in gigabytes (GB).","minimum":10,"maximum":2000},"Connection":{"description":"Details about the network connection for your cluster.","properties":{"datacenterId":{"description":"The datacenter to connect your cluster to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your cluster to.","type":"string"},"cidr":{"type":"string","description":"The IP and subnet for your cluster.\nNote the following unavailable IP ranges:\n10.233.64.0/18\n10.233.0.0/18\n10.233.114.0/24\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.","pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$"},"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 cluster.\n","properties":{"location":{"$ref":"#/components/schemas/BackupLocation"}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"Pagination":{"description":"Pagination information in list responses.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"total":{"$ref":"#/components/schemas/PaginationTotal"},"_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},"PaginationTotal":{"description":"The total number of elements matching the request (without pagination).\n","type":"integer","minimum":0,"default":0},"PaginationLinks":{"description":"URLs to navigate the different pages.\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 BackupList object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"BackupList":{"description":"List of backups.","allOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ResourceID"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BackupResponse"}}}},{"$ref":"#/components/schemas/Pagination"}],"type":"object"},"ResourceID":{"type":"string","description":"The unique ID of the resource."},"BackupResponse":{"description":"A database backup.","properties":{"id":{"$ref":"#/components/schemas/ResourceID"},"properties":{"$ref":"#/components/schemas/Backup"}},"type":"object"},"Backup":{"description":"A backup object.","properties":{"clusterId":{"type":"string","description":"The unique ID of the cluster that was backed up."},"location":{"$ref":"#/components/schemas/BackupLocation"},"earliestRecoveryTargetTime":{"type":"string","format":"date-time","description":"The oldest available timestamp to which you can restore."},"size":{"type":"integer","description":"Size of all base backups in MiB. This is at least the sum of\nall base backup sizes.\n"},"baseBackups":{"type":"array","items":{"$ref":"#/components/schemas/BaseBackup"}}},"type":"object"},"BackupLocation":{"type":"string","description":"The S3 location where the backups will be stored."},"BaseBackup":{"description":"A single base backup.","properties":{"created":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp."},"size":{"type":"integer","description":"The size of the backup in MiB. This is the\nsize of the binary backup file that was stored.\n"}},"type":"object"},"Pagination":{"description":"Pagination information in list responses.","type":"object","properties":{"offset":{"$ref":"#/components/schemas/PaginationOffset"},"limit":{"$ref":"#/components/schemas/PaginationLimit"},"total":{"$ref":"#/components/schemas/PaginationTotal"},"_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},"PaginationTotal":{"description":"The total number of elements matching the request (without pagination).\n","type":"integer","minimum":0,"default":0},"PaginationLinks":{"description":"URLs to navigate the different pages.\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 InitialDBUsername object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"InitialDBUsername":{"description":"The username for the initial MariaDB user. Some system usernames\nare restricted (e.g. \"mariadb\", \"admin\", \"standby\").\n\nThe username should be compliant with the following rules:\n- Must not exceed 16 characters\n- Must start with a letter\n- Must contain only letters, numbers, or underscores\n","minLength":1,"maxLength":16,"type":"string","pattern":"^[a-zA-Z]([a-zA-Z0-9]+_)*[a-zA-Z0-9]+$"}}}}
```

## The DBPassword object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"DBPassword":{"type":"string","description":"The password for a MariaDB user.","writeOnly":true,"minLength":10,"maxLength":63}}}}
```

## The RestoreRequest object

```json
{"openapi":"3.0.3","info":{"title":"IONOS DBaaS MariaDB REST API","version":"0.1.0"},"components":{"schemas":{"RestoreRequest":{"type":"object","required":["backupId"],"description":"Request payload to restore a cluster from a backup.\n","properties":{"backupId":{"$ref":"#/components/schemas/ResourceID"},"recoveryTargetTime":{"type":"string","format":"date-time","description":"The timestamp to which the cluster should be restored.\nIf empty, the backup will be applied to the latest\ntimestamp.\n\nThis value must be supplied as ISO 8601 timestamp, the\nbackup will be replayed up until the given timestamp.\nIf empty, the backup will be applied completely.\n\nMust be within the earliestRecoveryTargetTime and now.\n\nThe earliestRecoveryTargetTime can be looked up in the\nbackup object.\n"}}},"ResourceID":{"type":"string","description":"The unique ID of the resource."}}}}
```