IONOS DBaaS REST API (1.0.0)

An enterprise-grade Database is provided as a Service (DBaaS) solution that can be managed through a browser-based "Data Center Designer" (DCD) tool or via an easy to use API.

The API allows you to create additional database clusters or modify existing ones. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.

swagger 3 Source url

Authentication

Basic Authentication

You will need to base64 encode the string containing your credentials. Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication.

API key

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


Clusters

List clusters

Retrieves a list of PostgreSQL clusters.


get https://api.ionos.com/databases/postgresql /clusters Try out

Create a cluster

Creates a new PostgreSQL cluster.
If the fromBackup field is populated, the new cluster will be created
based on the given backup.


post https://api.ionos.com/databases/postgresql /clusters Try out

Fetch a cluster

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


get https://api.ionos.com/databases/postgresql /clusters/{clusterId} Try out

Patch a cluster

Patch attributes of a PostgreSQL cluster.


patch https://api.ionos.com/databases/postgresql /clusters/{clusterId} Try out

Delete a cluster

Delete a PostgreSQL cluster.


delete https://api.ionos.com/databases/postgresql /clusters/{clusterId} Try out

List PostgreSQL versions

Retrieves a list of all available PostgreSQL versions.


get https://api.ionos.com/databases/postgresql /clusters/postgresversions Try out

List PostgreSQL versions

Retrieves a list of all PostgreSQL versions available for this cluster
including the current version.


get https://api.ionos.com/databases/postgresql /clusters/{clusterId}/postgresversions Try out

Backups

List cluster backups

Retrieves a list of all PostgreSQL cluster backups.


get https://api.ionos.com/databases/postgresql /clusters/backups Try out

Fetch a cluster backup

Retrieve a PostgreSQL cluster backup by using its ID. This value can be
found when you GET a list of PostgreSQL cluster backups.


get https://api.ionos.com/databases/postgresql /clusters/backups/{backupId} Try out

List backups of cluster

Retrieves a list of all backups of the given PostgreSQL cluster.


get https://api.ionos.com/databases/postgresql /clusters/{clusterId}/backups Try out

Restores

In-place restore of a cluster

Triggers an in-place restore of the given PostgreSQL.


post https://api.ionos.com/databases/postgresql /clusters/{clusterId}/restore Try out

Logs

Get logs of your cluster

Retrieves PostgreSQL logs based on the given parameters.


get https://api.ionos.com/databases/postgresql /clusters/{clusterId}/logs Try out

Metadata

Get the current API version

Retrieves the current version of the responding API.


get https://api.ionos.com/databases/postgresql /infos/version Try out

Fetch all API versions

Retrieves all available versions of the responding API.


get https://api.ionos.com/databases/postgresql /infos/versions Try out