# Ubicloud Postgres Database API **Canonical:** https://apis.io/apis/ubicloud/ubicloud-postgres-database-api/ **Provider:** Ubicloud — https://apis.io/providers/ubicloud/ **Base URL:** https://api.ubicloud.com **Documentation:** https://www.ubicloud.com/docs/api-reference/overview Ubicloud Postgres Database API is one of 18 APIs that [Ubicloud](https://apis.io/providers/ubicloud/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Postgres Database. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas. Postgres Database Operations ## Operations (30) | Method | Path | Summary | |---|---|---| | GET | `/project/{project_id}/location/{location}/postgres` | List PostgreSQL databases in a location | | DELETE | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}` | Delete a PostgreSQL database | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}` | Get PostgreSQL database details | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}` | Create a new PostgreSQL database | | PATCH | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}` | Update a PostgreSQL database | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/backup` | List backups for a specific PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/backup-credentials` | Create temporary, read-only credentials for downloading backups directly from… | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/ca-certificates` | Download CA certificates for a PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/cert/add-auth-user` | Add provided name to list of users with certificate authentication | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/cert/create-client-keypair` | Create and return client certificate keypair with requested common name | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/cert/remove-auth-user` | Remove provided name from list of users with certificate authentication | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/config` | Get PostgreSQL database configuration | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/config` | Replace PostgreSQL database configuration | | PATCH | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/config` | Update PostgreSQL database configuration | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/logs` | Get PostgreSQL database logs | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/metrics` | Get PostgreSQL database metrics | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/promote` | Promote a PostgreSQL read replica (deprecated, use promote-read-replica) | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/promote-read-replica` | Promote a PostgreSQL read replica | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/read-replica` | Create a read replica of the PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/recycle` | Request primary to be recycled | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/rename` | Rename a PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/reset-superuser-password` | Reset superuser password of the PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/restart` | Restart a PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/restore` | Restore a PostgreSQL database | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/servers` | List servers for a specific PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/set-maintenance-window` | Set maintenance window for the PostgreSQL database | | POST | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/upgrade` | Upgrade a PostgreSQL database to the next major version | | GET | `/project/{project_id}/location/{location}/postgres/{postgres_database_reference}/upgrade` | Get PostgreSQL database upgrade status | | GET | `/project/{project_id}/postgres` | List all PostgreSQL databases | | GET | `/project/{project_id}/postgres/capabilities` | Get available PostgreSQL provisioning options | ## Machine-readable artifacts (8) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/openapi/ubicloud-postgres-database-api-openapi.yml - **Documentation** — https://www.ubicloud.com/docs/api-reference/overview - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/json-schema/ubicloud-postgres-capabilities-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/json-schema/ubicloud-firewall-rule-update-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/json-schema/ubicloud-postgres-config-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/json-schema/ubicloud-postgres-patch-config-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/json-schema/ubicloud-ssh-public-key-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/ubicloud/refs/heads/main/json-schema/ubicloud-ssh-public-key-update-schema.json ## Other Ubicloud APIs (12) - [Ubicloud Audit Log API](https://apis.io/apis/ubicloud/ubicloud-audit-log-api/) - [Ubicloud Firewall API](https://apis.io/apis/ubicloud/ubicloud-firewall-api/) - [Ubicloud Firewall Rule API](https://apis.io/apis/ubicloud/ubicloud-firewall-rule-api/) - [Ubicloud GitHub API](https://apis.io/apis/ubicloud/ubicloud-github-api/) - [Ubicloud Inference Api Key API](https://apis.io/apis/ubicloud/ubicloud-inference-api-key-api/) - [Ubicloud Inference Endpoint API](https://apis.io/apis/ubicloud/ubicloud-inference-endpoint-api/) - [Ubicloud Kubernetes Cluster API](https://apis.io/apis/ubicloud/ubicloud-kubernetes-cluster-api/) - [Ubicloud Load Balancer API](https://apis.io/apis/ubicloud/ubicloud-load-balancer-api/) - [Ubicloud Machine Image API](https://apis.io/apis/ubicloud/ubicloud-machine-image-api/) - [Ubicloud Postgres Firewall Rule API](https://apis.io/apis/ubicloud/ubicloud-postgres-firewall-rule-api/) - [Ubicloud Postgres Log Destination API](https://apis.io/apis/ubicloud/ubicloud-postgres-log-destination-api/) - [Ubicloud Postgres Metric Destination API](https://apis.io/apis/ubicloud/ubicloud-postgres-metric-destination-api/) ## Tags Postgres Database --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ubicloud/ubicloud-postgres-database-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ubicloud/.