Get Database Pool Information
GET /obp/v7.0.0/system/database/pool
OBPv6.0.0-getDatabasePoolInfo Roles: CanGetDatabasePoolInfo SystemAPI
Returns HikariCP connection pool information including:
- Pool name
- Active connections: currently in use
- Idle connections: available in pool
- Total connections: active + idle
- Threads awaiting connection: requests waiting for a connection
- Configuration: max pool size, min idle, timeouts
This helps diagnose connection pool issues such as connection leaks or pool exhaustion.
Authentication is Required
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (11)
- active_connections
- active_connections
- connection_timeout_ms
- connection_timeout_ms
- idle_connections
- idle_connections
- idle_timeout_ms
- idle_timeout_ms
- keepalive_time_ms
- keepalive_time_ms
- max_lifetime_ms
- max_lifetime_ms
- maximum_pool_size
- maximum_pool_size
- minimum_idle
- minimum_idle
- pool_name
- pool_name
- threads_awaiting_connection
- threads_awaiting_connection
- total_connections
- total_connections
Example success response
{
"pool_name": "HikariPool-1",
"active_connections": 5,
"idle_connections": 3,
"total_connections": 8,
"threads_awaiting_connection": 0,
"maximum_pool_size": 10,
"minimum_idle": 2,
"connection_timeout_ms": 30000,
"idle_timeout_ms": 600000,
"max_lifetime_ms": 1800000,
"keepalive_time_ms": 0
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.