API How-Tos

Quick Links:

DBaaS API - OpenAPI Specification

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

Header	Required	Type	Description
Authorization	yes	string	HTTP Basic authorization. A base64 encoded string of a username and password separated by a colon. `username@domain.tld: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`.

Authorization

yes

string

HTTP Basic authorization. A base64 encoded string of a username and password separated by a colon. username@domain.tld:password

X-Contract-Number

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:

PreviousView Cluster Metrics NextSet Up a Database Cluster

Last updated 1 year ago