Databases

Turn the connection pooler on (transaction mode by default) or change its settings

put/databases/{databaseId}/pooler

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/databases/{databaseId}/pooler
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

databaseIdstring uuid required

Request body

mode'transaction' | 'session'
defaultPoolSizeinteger
maxClientConnectionsinteger

Response

Pooler (provisioning)

databaseIdstring uuid required
supportedboolean required

connection pooling exists for PostgreSQL only

enabledboolean required
status'disabled' | 'provisioning' | 'running' | 'error' required
statusDetailstring nullable required
mode'transaction' | 'session' required

transaction (default): a server connection per transaction; session: per client connection

defaultPoolSizeinteger required

server connections to PostgreSQL per database/user pair

maxClientConnectionsinteger required

client connections PgBouncer accepts

hoststring nullable required

internal host of the pooler, reachable from the organization's projects

portinteger nullable required
pooledUrlstring nullable required

pooled connection URL; masked unless revealed (databases:reveal and ?reveal=true)

directUrlstring nullable required

the database's direct connection URL (migrations, LISTEN/NOTIFY, long sessions); masked unless revealed

notesstring[] required

what to keep in mind in the chosen mode

updatedAtstring nullable required

ISO-8601 timestamp

Changes

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