IONOS Cloud DBaaS icon

IONOS Cloud DBaaS

Manage IONOS Cloud Database as a Service (PostgreSQL, MongoDB, MariaDB, Redis). Developped with Love by Ascenzia (ascenzia.fr)

PostgreSQL → Get

AI-generated

Summary

Retrieve a PostgreSQL resource (cluster, user, database, backup, or logs).

Inputs

  • postgresqlResource (required) — The type of PostgreSQL resource to retrieve. Options: cluster, user, database, backup, log.
  • clusterId (required) — The unique ID of the PostgreSQL cluster. Required when retrieving clusters, users, databases, or logs.
  • backupId (required) — The unique ID of the PostgreSQL backup. Required when retrieving backups.
  • username (required) — The PostgreSQL username. Required when retrieving a specific user.
  • databaseName (required) — The database name. Required when retrieving a specific database.
  • location (required) — The location/region for the database. Shown only when retrieving a cluster; hidden for users, databases, backups, and logs.

Output shape

The requested PostgreSQL resource data from the IONOS API. Shape depends on the selected resource type: cluster details, user details, database details, backup details, or log entries.

All responses are fetched via GET requests to the IONOS PostgreSQL API. The operation consumes the specified parameters and returns the corresponding resource data; no side effects occur.

Examples

Example 1: Retrieve a specific PostgreSQL cluster

Set postgresqlResource to 'cluster', provide clusterId, and optionally set location.

Example 2: Retrieve PostgreSQL logs for a cluster

Set postgresqlResource to 'log', provide clusterId.

Links

Discussion