Clusters

Everything about MariaDB clusters.

List clusters

get

https://mariadb.de-fra.ionos.comhttps://mariadb.de-txl.ionos.comhttps://mariadb.es-vit.ionos.comhttps://mariadb.fr-par.ionos.comhttps://mariadb.gb-lhr.ionos.comhttps://mariadb.us-ewr.ionos.comhttps://mariadb.us-las.ionos.comhttps://mariadb.us-mci.ionos.com

/clusters

Retrieves a list of MariaDB clusters.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Query parameters

limitinteger · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with 'offset' for pagination.

Default: 100Example: 100

offsetintegerOptional

The first element to return. Use together with 'limit' for pagination.

Default: 0Example: 200

filter.namestringOptional

Response filter to list only the MariaDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.

Responses

200

Successful operation.

application/json

Pagination information in list responses.

idstringOptional

The unique ID of the resource.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

offsetintegerOptional

The offset specified in the request (if none was specified, the default offset is 0).

Default: 0Example: 200

limitinteger · max: 1000Optional

The limit specified in the request (if none was specified, the default limit is 100).

Default: 100Example: 100

totalintegerOptional

The total number of elements matching the request (without pagination).

Default: 0Example: 200

400

Parse error.

application/json

401

Authentication error.

application/json

403

Unauthorized.

application/json

404

Not Found.

application/json

405

Unsupported HTTP method.

application/json

415

Unsupported content type.

application/json

422

Validation error.

application/json

429

Request rate limit exceeded.

application/json

500

Server error.

application/json

503

Maintenance.

application/json

get

/clusters

HTTPcURLJavaScriptPython

GET /clusters HTTP/1.1
Host: mariadb.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "items": [
    {
      "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "[email protected]",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "state": "AVAILABLE"
      },
      "properties": {
        "displayName": "MariaDB cluster",
        "mariadbVersion": "10.6",
        "dnsName": "ma-yourcluster.mariadb.region.ionos.com",
        "instances": 3,
        "ram": 4,
        "cores": 4,
        "storageSize": 10,
        "connections": [
          {
            "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
            "lanId": "2",
            "cidr": "192.168.1.100/24"
          }
        ],
        "maintenanceWindow": {
          "time": "16:30:59",
          "dayOfTheWeek": "Monday"
        },
        "backup": {
          "location": "de"
        }
      }
    }
  ],
  "offset": 200,
  "limit": 100,
  "total": 200,
  "_links": {
    "prev": "<PREVIOUS-PAGE-URI>",
    "self": "<THIS-PAGE-URI>",
    "next": "<NEXT-PAGE-URI>"
  }
}

Create a cluster

post

https://mariadb.de-fra.ionos.comhttps://mariadb.de-txl.ionos.comhttps://mariadb.es-vit.ionos.comhttps://mariadb.fr-par.ionos.comhttps://mariadb.gb-lhr.ionos.comhttps://mariadb.us-ewr.ionos.comhttps://mariadb.us-las.ionos.comhttps://mariadb.us-mci.ionos.com

/clusters

Creates a new MariaDB cluster.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Body

application/json

Request payload with all data needed to create a new MariaDB cluster.

Responses

200

The created cluster is returned with metadata.state set to "BUSY".

application/json

A database cluster.

idstringOptional

The unique ID of the resource.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

400

Parse error.

application/json

401

Authentication error.

application/json

403

Unauthorized.

application/json

404

Not Found.

application/json

405

Unsupported HTTP method.

application/json

415

Unsupported content type.

application/json

422

Validation error.

application/json

429

Request rate limit exceeded.

application/json

500

Server error.

application/json

503

Maintenance.

application/json

post

/clusters

HTTPcURLJavaScriptPython

POST /clusters HTTP/1.1
Host: mariadb.de-fra.ionos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 515

{
  "properties": {
    "mariadbVersion": "10.6",
    "instances": 3,
    "cores": 4,
    "ram": 4,
    "storageSize": 10,
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "displayName": "MariaDB cluster",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    },
    "credentials": {
      "username": "cluster_admin",
      "password": "my-t0p-secret-password"
    },
    "fromBackup": {
      "backupId": "498ae72f-411f-11eb-9d07-046c59cc737e",
      "recoveryTargetTime": "2020-12-10T13:37:50+01:00"
    }
  }
}

{
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "state": "AVAILABLE"
  },
  "properties": {
    "displayName": "MariaDB cluster",
    "mariadbVersion": "10.6",
    "dnsName": "ma-yourcluster.mariadb.region.ionos.com",
    "instances": 3,
    "ram": 4,
    "cores": 4,
    "storageSize": 10,
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    }
  }
}

Fetch a cluster

get

https://mariadb.de-fra.ionos.comhttps://mariadb.de-txl.ionos.comhttps://mariadb.es-vit.ionos.comhttps://mariadb.fr-par.ionos.comhttps://mariadb.gb-lhr.ionos.comhttps://mariadb.us-ewr.ionos.comhttps://mariadb.us-las.ionos.comhttps://mariadb.us-mci.ionos.com

/clusters/{clusterId}

You can retrieve a MariaDB cluster by using its ID. This value can be found in the response body when a MariaDB cluster is created or when you GET a list of MariaDB clusters.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

Responses

200

Successful operation.

application/json

A database cluster.

idstringOptional

The unique ID of the resource.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

400

Parse error.

application/json

401

Authentication error.

application/json

403

Unauthorized.

application/json

404

Not Found.

application/json

405

Unsupported HTTP method.

application/json

415

Unsupported content type.

application/json

422

Validation error.

application/json

429

Request rate limit exceeded.

application/json

500

Server error.

application/json

503

Maintenance.

application/json

get

/clusters/{clusterId}

HTTPcURLJavaScriptPython

GET /clusters/{clusterId} HTTP/1.1
Host: mariadb.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "state": "AVAILABLE"
  },
  "properties": {
    "displayName": "MariaDB cluster",
    "mariadbVersion": "10.6",
    "dnsName": "ma-yourcluster.mariadb.region.ionos.com",
    "instances": 3,
    "ram": 4,
    "cores": 4,
    "storageSize": 10,
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    }
  }
}

Delete a cluster

delete

https://mariadb.de-fra.ionos.comhttps://mariadb.de-txl.ionos.comhttps://mariadb.es-vit.ionos.comhttps://mariadb.fr-par.ionos.comhttps://mariadb.gb-lhr.ionos.comhttps://mariadb.us-ewr.ionos.comhttps://mariadb.us-las.ionos.comhttps://mariadb.us-mci.ionos.com

/clusters/{clusterId}

Delete a MariaDB cluster.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

Responses

200

The deleted cluster with metadata.state set to "DESTROYING".

application/json

A database cluster.

idstringOptional

The unique ID of the resource.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

400

Parse error.

application/json

401

Authentication error.

application/json

403

Unauthorized.

application/json

404

Not Found.

application/json

405

Unsupported HTTP method.

application/json

415

Unsupported content type.

application/json

422

Validation error.

application/json

429

Request rate limit exceeded.

application/json

500

Server error.

application/json

503

Maintenance.

application/json

delete

/clusters/{clusterId}

HTTPcURLJavaScriptPython

DELETE /clusters/{clusterId} HTTP/1.1
Host: mariadb.de-fra.ionos.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "state": "AVAILABLE"
  },
  "properties": {
    "displayName": "MariaDB cluster",
    "mariadbVersion": "10.6",
    "dnsName": "ma-yourcluster.mariadb.region.ionos.com",
    "instances": 3,
    "ram": 4,
    "cores": 4,
    "storageSize": 10,
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    }
  }
}

Update a cluster

patch

https://mariadb.de-fra.ionos.comhttps://mariadb.de-txl.ionos.comhttps://mariadb.es-vit.ionos.comhttps://mariadb.fr-par.ionos.comhttps://mariadb.gb-lhr.ionos.comhttps://mariadb.us-ewr.ionos.comhttps://mariadb.us-las.ionos.comhttps://mariadb.us-mci.ionos.com

/clusters/{clusterId}

Updates mutable attributes on a MariaDB cluster.

Authorizations

tokenAuth

AuthorizationstringRequired

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

Body

application/json

Request payload to change a cluster.

Responses

200

Successful operation.

application/json

A database cluster.

idstringOptional

The unique ID of the resource.

Example: 498ae72f-411f-11eb-9d07-046c59cc737e

400

Parse error.

application/json

401

Authentication error.

application/json

403

Unauthorized.

application/json

404

Not Found.

application/json

405

Unsupported HTTP method.

application/json

415

Unsupported content type.

application/json

422

Validation error.

application/json

429

Request rate limit exceeded.

application/json

500

Server error.

application/json

503

Maintenance.

application/json

patch

/clusters/{clusterId}

HTTPcURLJavaScriptPython

PATCH /clusters/{clusterId} HTTP/1.1
Host: mariadb.de-fra.ionos.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 501

{
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "state": "AVAILABLE"
  },
  "properties": {
    "mariadbVersion": "10.6",
    "instances": 3,
    "cores": 4,
    "ram": 4,
    "storageSize": 10,
    "displayName": "MariaDB cluster",
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    }
  }
}

{
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "state": "AVAILABLE"
  },
  "properties": {
    "displayName": "MariaDB cluster",
    "mariadbVersion": "10.6",
    "dnsName": "ma-yourcluster.mariadb.region.ionos.com",
    "instances": 3,
    "ram": 4,
    "cores": 4,
    "storageSize": 10,
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    }
  }
}