PostgreSQL v1 API

The creation of PostgreSQL cluster functionality that is available in the IONOS Cloud DCD is also available through the API.

What you can do with the PostgreSQL v1 API?

Use the PostgreSQL v1 API to:

• Create and manage PostgreSQL database clusters

• Manage database users and access controls

• Filter and paginate by cluster name

• Handle backups and restores

• Access cluster logs for monitoring and troubleshooting

PostgreSQL v1 OpenAPI Specification

Endpoint: https://api.ionos.com/databases/postgresql

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:

Linux cURL - How to use the Curl Command in LinuxIONOS Digital Guide

Getting started with cURL in WindowsIONOS Digital Guide

Quick Links

Set Up a PostgreSQL Cluster

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

Modify Cluster Attributes

Learn how to modify attributes of an existing PostgreSQL cluster.

Manage Users and Databses

Learn how to manage users and database clusters of PostgreSQL.

Connect from Kubernetes

Learn how to connect to a database from your managed Kubernetes cluster.

View Cluster Metrics

Learn how to view metrics for your PostgreSQL cluster.