For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.databases.get_connection_pool(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    pool_name="backend-pool",
)

Description

To show information about an existing connection pool for a PostgreSQL database cluster, send a GET request to /v2/databases/{database_cluster_uuid}/pools/{pool_name}. The response will be a JSON object with a pool key.

Parameters

database_cluster_uuid string required

A unique identifier for a database cluster.

pool_name string required

The name used to identify the connection pool.

Request Sample

import os
from pydo import Client

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

get_resp = client.databases.get_connection_pool(database_cluster_uuid="a7aba8a", pool_name="backend-pool") 

Response Example

{
  "pool": {
    "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/{pool_name} in the API reference for additional detail on responses, headers, parameters, and more.