Give Feedback

pydo.databases.list_connection_pools()

Generated on 3 Aug 2026 from pydo version v0.40.0

Copy page as Markdown View page as Markdown

Usage

client.databases.list_connection_pools(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
)

Returns JSONRaises HttpResponseError

Description

To list all of the connection pools available to a PostgreSQL database cluster, send a GET request to /v2/databases/{database_cluster_uuid}/pools. The result will be a JSON object with a pools key. This will be set to an array of connection pool objects.

Parameters

database_cluster_uuid string required: A unique identifier for a database cluster.

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.databases.list_connection_pools(database_cluster_uuid="a7aab9a")

Response Example

Show Response Example

{
  "pools": [
    {
      "user": "doadmin",
      "name": "reporting-pool",
      "size": 10,
      "db": "defaultdb",
      "mode": "session",
      "connection": {
        "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/foo?sslmode=require",
        "database": "foo",
        "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
        "port": 25061,
        "user": "doadmin",
        "password": "wv78n3zpz42xezdk",
        "ssl": true
      }
    },
    {
      "user": "doadmin",
      "name": "backend-pool",
      "size": 10,
      "db": "defaultdb",
      "mode": "transaction",
      "connection": {
        "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/backend-pool?sslmode=require",
        "database": "backend-pool",
        "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
        "port": 25061,
        "user": "doadmin",
        "password": "wv78n3zpz42xezdk",
        "ssl": true
      }
    }
  ]
}

More Information

See /v2/databases/{database_cluster_uuid}/pools in the API reference for additional detail on responses, headers, parameters, and more.