API How-Tos

This section provides detailed guides on how to perform various tasks using the PostgreSQL API. Each guide includes step-by-step instructions and examples to help you effectively manage your PostgreSQL clusters.

Quick Links:

Set Up a Cluster (API)

Learn how to set up a PostgreSQL cluster using the API.

Modify Cluster Attributes

Learn how to modify attributes of an existing PostgreSQL cluster.

Access Logs

Learn how to access logs for your PostgreSQL cluster.

Database Migration

Learn how to migrate your database to a PostgreSQL cluster.

Restore from Backup

Learn how to restore your PostgreSQL cluster from a backup.

Activate Extensions

Learn how to activate extensions in your PostgreSQL cluster.

View Cluster Metrics

Learn how to view metrics for your PostgreSQL cluster.

DBaaS API - OpenAPI Specification

IONOS DBaaS REST API

Click here for the OpenAPI Specification File

Endpoint: https://api.ionos.com/docs/postgresql/v1/

To make authenticated requests to the API, you must include a few fields in the request headers. Please find relevant descriptions below:

Request parameter headers

Header	Required	Type	Description
Authorization	yes	string	HTTP Basic authorization. A base64 encoded string of a username and password separated by a colon. [email protected]: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

We use curl in our examples, as this tool is available on Windows 10, Linux and macOS. Please refer to our blogpost about curl on Windows if you encounter any problems:

cURL in Linux: what you need to know to get startedIONOS Digitalguide

Getting started with cURL in WindowsIONOS Digitalguide