database

Modify connection pool

Modifies the connection pool {pool-name} for the Managed Database service {uuid}.

patch/1.3/database/{uuid}/connection-pools/{pool-name}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/database/{uuid}/connection-pools/{pool-name}
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

The unique identifier for the integration.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

pool-namestring required

The title of an entity.

Example:my-service

Connection Pool Name

Request body

databasestring

Database

pool_mode'session' | 'transaction' | 'statement'

Connection Pool mode

pool_sizeinteger

Connection Pool size

usernamestring nullable

Connection Pool username

Example request

{
  "database": "defaultdb",
  "pool_mode": "session",
  "pool_size": 20,
  "username": "app-user"
}

Response

OK

connection_uristring uri

The connection URI of the connection pool.

databasestring

The database name associated with the connection pool.

pool_modestring

The mode of the connection pool.

pool_namestring

The name of the connection pool.

pool_sizeinteger

The size of the connection pool.

usernamestring

The username for the connection pool

Example response

{
  "connection_uri": "postgresql://user:password@hostname:5432/dbname",
  "database": "defaultdb",
  "pool_mode": "session",
  "pool_name": "pool-2",
  "pool_size": 10,
  "username": "updamin"
}

Changes

No recorded changes to this operation across all 1 revision of this API.