PostgreSQL v1 API

The PostgreSQL cluster functionality available in the IONOS CLOUD Data Center Designer (DCD) is also available through the API.

The PostgreSQL v1 API refers to the existing API and works alongside the PostgreSQL v2 API.

Important:

• Effective September 28, 2026, PostgreSQL v1 functionality will be decomissioned. Use PostgreSQL v2 to create and manage clusters using the DCD or the API.

• Cluster creation using PostgreSQL v1 API is deprecated effective July 15, 2026.

• Existing PostgreSQL v1 clusters will be automatically migrated to the new PostgreSQL v2 infrastructure starting July 29, 2026. No user action is required and we will notify you before the migration. If you prefer to migrate earlier, see Manual migration.

What can you do with the PostgreSQL v1 API?

Use the PostgreSQL v1 API to:

• Manage existing 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 IONOS CLOUD DCD login 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 which contract it applies to.
Content-Type	yes	string	Set this to application/json.

Examples

We use curl in our examples because it is available on Windows 10, Linux, and macOS. If you encounter any problems with curl on Linux or Windows, refer to the following:

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 Databases

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.