List Connection Pools (PostgreSQL)

v1.0.0

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

Input

{
  "type": "object",
  "properties": {
    "database_cluster_uuid": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "database_cluster_uuid"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "pools": {
      "type": "array",
      "description": "An array of connection pool objects.",
      "items": {
        "type": "object",
        "required": [
          "name",
          "mode",
          "size",
          "db"
        ],
        "properties": {
          "connection": {
            "type": "object"
          },
          "db": {
            "type": "string",
            "description": "The database for use with the connection pool."
          },
          "mode": {
            "type": "string",
            "description": "The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement."
          },
          "name": {
            "type": "string",
            "description": "A unique name for the connection pool. Must be between 3 and 60 characters."
          },
          "private_connection": {
            "type": "object"
          },
          "size": {
            "type": "integer",
            "format": "int32",
            "description": "The desired size of the PGBouncer connection pool. The maximum allowed size is determined by the size of the cluster's primary node. 25 backend server connections are allowed for every 1GB of RAM. Three are reserved for maintenance. For example, a primary node with 1 GB of RAM allows for a maximum of 22 backend server connections while one with 4 GB would allow for 97. Note that these are shared across all connection pools in a cluster."
          },
          "user": {
            "type": "string",
            "description": "The name of the user for use with the connection pool. When excluded, all sessions connect to the database as the inbound user."
          }
        }
      }
    }
  }
}