Getting started

Introduction

IONOS provides an endpoint that returns all available API Versions and an URL to their respective Swagger definition: https://api.ionos.com/cloudapi/databases/postgres/infos/versions. In this documentation we'll be using Version v1.0.

https://api.ionos.com/cloudapi/databases/postgres/infos/assets/swagger-v1.0.yml

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: https://www.ionos.de/digitalguide/server/tools/einstieg-in-curl-in-windows/

The base URL for all our requests is: https://api.ionos.com/cloudapi/databases/postgres

To make authenticated requests to the API, you must include a few fields in the request headers.

Request parameter headers

Header

Required

Type

Default

Description

Authorization

yes

string

n/a

HTTP Basic authorization. A base64 encoded string of a username and password separated by a colon. "[email protected]:password"

X-Contract-Number

no

integer

n/a

Users with more than one contract may apply this header to indicate the applicable contract.

Content-Type

yes

string

n/a

Set this to "application/json".

To make authenticated requests to the API, you must include a few fields in the request headers. For explanation of each see the relevant description.