For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

What Can You 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 IONOS CLOUD DCD login 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 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:

Last updated

Was this helpful?