API How-Tos

Quick Links:

Set Up a Cluster (API)	Modify Cluster Attributes	Access Logs
Database Migration	Restore from Backup	Activate Extensions
View Cluster Metrics

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. [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

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