Skip to content
Console(the OVHcloud Console, opens in a new tab)

Pools

All operations require authentication.

6 operationsv2/publicCloud/project
OpenAPI
Agent setup

List connection poolsBeta

GET
/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool

Returns the connection pools of the service.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200ConnectionPool[]successful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

databaseId
read-only
stringuuid

Identifier of the target database schema

id
read-only
stringuuid

Unique identifier of the connection pool

mode
read-only
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
read-only
string

Name of the connection pool

port
read-only
integer

TCP port on which the connection pool listens

size
read-only
integer

Maximum number of server connections in the pool

sslMode
read-only
SSLModeEnum

SSL connection mode for the pool

ValuesREQUIRE
updatedAt
read-only
stringdate-time

Date of the last update to the resource

uri
read-only
string

Connection URI to the pool

userId
read-only
stringuuid

Unique identifier of the database user used to establish server connections. Null when no user is assigned.

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "checksum": "string",    "createdAt": "2024-01-01T12:00:00Z",    "databaseId": "00000000-0000-0000-0000-000000000000",    "id": "00000000-0000-0000-0000-000000000000",    "mode": "SESSION",    "name": "string",    "port": 0,    "size": 0,    "sslMode": "REQUIRE",    "updatedAt": "2024-01-01T12:00:00Z",    "uri": "string",    "userId": "00000000-0000-0000-0000-000000000000"  }]

Get a connection poolBeta

GET
/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId}

Returns the connection pool settings and its connection URI.

Path parameters

connectionPoolId
required
stringuuid

Connection pool ID

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Response

200ConnectionPoolsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

databaseId
read-only
stringuuid

Identifier of the target database schema

id
read-only
stringuuid

Unique identifier of the connection pool

mode
read-only
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
read-only
string

Name of the connection pool

port
read-only
integer

TCP port on which the connection pool listens

size
read-only
integer

Maximum number of server connections in the pool

sslMode
read-only
SSLModeEnum

SSL connection mode for the pool

ValuesREQUIRE
updatedAt
read-only
stringdate-time

Date of the last update to the resource

uri
read-only
string

Connection URI to the pool

userId
read-only
stringuuid

Unique identifier of the database user used to establish server connections. Null when no user is assigned.

Example uses connectionPoolId = 00000000-0000-0000-0000-000000000000, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "databaseId": "00000000-0000-0000-0000-000000000000",  "id": "00000000-0000-0000-0000-000000000000",  "mode": "SESSION",  "name": "string",  "port": 0,  "size": 0,  "sslMode": "REQUIRE",  "updatedAt": "2024-01-01T12:00:00Z",  "uri": "string",  "userId": "00000000-0000-0000-0000-000000000000"}

Create a connection poolBeta

POST
/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool

Creates a connection pool on a database, with a pooling mode and a maximum number of server connections. Without userId, a system user opens the server connections.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Request body (required)

databaseId
required
stringuuid

Identifier of the target database schema

mode
required
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
required
string

Name of the connection pool

size
required
integer

Maximum number of server connections in the pool

userId
stringuuid

Unique identifier of the database user for server connections. Null to use a system user.

Response

200ConnectionPoolsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

databaseId
read-only
stringuuid

Identifier of the target database schema

id
read-only
stringuuid

Unique identifier of the connection pool

mode
read-only
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
read-only
string

Name of the connection pool

port
read-only
integer

TCP port on which the connection pool listens

size
read-only
integer

Maximum number of server connections in the pool

sslMode
read-only
SSLModeEnum

SSL connection mode for the pool

ValuesREQUIRE
updatedAt
read-only
stringdate-time

Date of the last update to the resource

uri
read-only
string

Connection URI to the pool

userId
read-only
stringuuid

Unique identifier of the database user used to establish server connections. Null when no user is assigned.

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "databaseId": "00000000-0000-0000-0000-000000000000",  "id": "00000000-0000-0000-0000-000000000000",  "mode": "SESSION",  "name": "string",  "port": 0,  "size": 0,  "sslMode": "REQUIRE",  "updatedAt": "2024-01-01T12:00:00Z",  "uri": "string",  "userId": "00000000-0000-0000-0000-000000000000"}

Delete a connection poolBeta

DELETE
/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId}

Deletes the connection pool.

Path parameters

connectionPoolId
required
stringuuid

Connection pool ID

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Response

200ConnectionPoolsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

databaseId
read-only
stringuuid

Identifier of the target database schema

id
read-only
stringuuid

Unique identifier of the connection pool

mode
read-only
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
read-only
string

Name of the connection pool

port
read-only
integer

TCP port on which the connection pool listens

size
read-only
integer

Maximum number of server connections in the pool

sslMode
read-only
SSLModeEnum

SSL connection mode for the pool

ValuesREQUIRE
updatedAt
read-only
stringdate-time

Date of the last update to the resource

uri
read-only
string

Connection URI to the pool

userId
read-only
stringuuid

Unique identifier of the database user used to establish server connections. Null when no user is assigned.

Example uses connectionPoolId = 00000000-0000-0000-0000-000000000000, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "databaseId": "00000000-0000-0000-0000-000000000000",  "id": "00000000-0000-0000-0000-000000000000",  "mode": "SESSION",  "name": "string",  "port": 0,  "size": 0,  "sslMode": "REQUIRE",  "updatedAt": "2024-01-01T12:00:00Z",  "uri": "string",  "userId": "00000000-0000-0000-0000-000000000000"}

Update a connection poolBeta

PUT
/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId}

Updates the database, pooling mode, size and user of the connection pool. Every field is required. Setting userId to null removes the user assignment.

Path parameters

connectionPoolId
required
stringuuid

Connection pool ID

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Request body (required)

databaseId
required
stringuuid

Identifier of the target database schema

mode
required
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
size
required
integer

Maximum number of server connections in the pool

userId
required
stringuuid

Unique identifier of the database user for server connections. Null to remove the user assignment.

Response

200ConnectionPoolsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

databaseId
read-only
stringuuid

Identifier of the target database schema

id
read-only
stringuuid

Unique identifier of the connection pool

mode
read-only
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
read-only
string

Name of the connection pool

port
read-only
integer

TCP port on which the connection pool listens

size
read-only
integer

Maximum number of server connections in the pool

sslMode
read-only
SSLModeEnum

SSL connection mode for the pool

ValuesREQUIRE
updatedAt
read-only
stringdate-time

Date of the last update to the resource

uri
read-only
string

Connection URI to the pool

userId
read-only
stringuuid

Unique identifier of the database user used to establish server connections. Null when no user is assigned.

Example uses connectionPoolId = 00000000-0000-0000-0000-000000000000, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "databaseId": "00000000-0000-0000-0000-000000000000",  "id": "00000000-0000-0000-0000-000000000000",  "mode": "SESSION",  "name": "string",  "port": 0,  "size": 0,  "sslMode": "REQUIRE",  "updatedAt": "2024-01-01T12:00:00Z",  "uri": "string",  "userId": "00000000-0000-0000-0000-000000000000"}

Partially update a connection poolBeta

PATCH
/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId}

Partially updates the database, pooling mode, size or user of the connection pool. Setting userId to null removes the user assignment.

Path parameters

connectionPoolId
required
stringuuid

Connection pool ID

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Request body (required)

databaseId
stringuuid

Identifier of the target database schema

mode
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
size
integer

Maximum number of server connections in the pool

userId
stringuuid

Unique identifier of the database user for server connections. Null to remove the user assignment.

Response

200ConnectionPoolsuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the resource was created

databaseId
read-only
stringuuid

Identifier of the target database schema

id
read-only
stringuuid

Unique identifier of the connection pool

mode
read-only
ConnectionPoolModeEnum

PgBouncer pooling mode

ValuesSESSIONSTATEMENTTRANSACTION
name
read-only
string

Name of the connection pool

port
read-only
integer

TCP port on which the connection pool listens

size
read-only
integer

Maximum number of server connections in the pool

sslMode
read-only
SSLModeEnum

SSL connection mode for the pool

ValuesREQUIRE
updatedAt
read-only
stringdate-time

Date of the last update to the resource

uri
read-only
string

Connection URI to the pool

userId
read-only
stringuuid

Unique identifier of the database user used to establish server connections. Null when no user is assigned.

Example uses connectionPoolId = 00000000-0000-0000-0000-000000000000, projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/postgresql/{serviceId}/connectionPool/{connectionPoolId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "databaseId": "00000000-0000-0000-0000-000000000000",  "id": "00000000-0000-0000-0000-000000000000",  "mode": "SESSION",  "name": "string",  "port": 0,  "size": 0,  "sslMode": "REQUIRE",  "updatedAt": "2024-01-01T12:00:00Z",  "uri": "string",  "userId": "00000000-0000-0000-0000-000000000000"}