API How-Tos

This section provides detailed guides and examples on how to interact with the MariaDB REST API. Each guide covers specific tasks such as creating, managing, and deleting MariaDB clusters, as well as handling backups and connecting from Kubernetes.

Quick Links

Prerequisites

A list of prerequisites to assure success with MariaDB creation.

Create a MariaDB Cluster

Learn to create a MariaDB cluster.

Verify the status of a MariaDB Cluster

Learn to verify the status of a MariaDB cluster.

Connect from Kubernetes

Learn how to connect to MariaDB from your managed Kubernetes cluster.

List MariaDB Clusters

Learn how to list the MariaDB clusters.

Fetch a MariaDB Cluster

Learn how to fetch a specific MariaDB cluster.

Delete a MariaDB Cluster

Learn how to delete a specific MariaDB cluster.

List MariaDB Cluster Backups

Learn how to retrieve a list of backups for all MariaDB clusters.

Fetch a specific Backup of a MariaDB Cluster

Learn how to retrieve a specific backup of a MariaDB cluster.

Retrieve all Backups of a MariaDB Cluster

Learn how to retrieve all backups of a specific MariaDB cluster.

Create a MariaDB Cluster from a Backup

Learn how to create a MariaDB cluster from an existing backup.

Restore a MariaDB Cluster from a Backup

Learn how to restore a MariaDB cluster from a backup.

Endpoints

A regional endpoint is necessary to interact with the MariaDB REST API endpoints. For more information, see the API specification file.

IONOS supports the following endpoints for various locations:

• Berlin, Germany: https://mariadb.de-txl.ionos.com/clusters.

• Frankfurt, Germany: https://mariadb.de-fra.ionos.com/clusters

• Logroño, Spain: https://mariadb.es-vit.ionos.com/clusters

• London, United Kingdom: https://mariadb.gb-lhr.ionos.com/clusters

• Worcester, United Kingdom: https://mariadb.gb-bhx.ionos.com/clusters

• Newark, United States: https://mariadb.us-ewr.ionos.com/clusters

• Las Vegas, United States: https://mariadb.us-las.ionos.com/clusters

• Lenexa, United States: https://mariadb.us-mci.ionos.com/clusters

• Paris, France: https://mariadb.fr-par.ionos.com/clusters

Request parameter headers

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

Header	Required	Type	Description
Authorization	yes	string	HTTP Basic authorization. A base64 encoded string of a username and password separated by a colon. [e-mail]:password
X-Contract-Number	no	integer	Users with more than one contract may apply this header to indicate the applicable contract.
Content-Type	yes	string	Set this to application/json.

Examples

The documentation contains curl examples, as the tool is available on Windows 10, Linux, and macOS. You can also refer to the following blog posts on the IONOS website that describe how to execute curl in Linux and Windows systems if you encounter any problems.