Get Stored Procedure Connector Health
GET /obp/v7.0.0/system/connectors/stored_procedure_vDec2019/health
OBPv6.0.0-getStoredProcedureConnectorHealth Roles: CanGetConnectorHealth ConnectorSystemAPI
Returns health status of the stored procedure connector including:
- Connection status (ok/error)
- Database server name: identifies which backend node handled the request (useful for load balancer diagnostics)
- Server IP address
- Database name
- Response time in milliseconds
- Error message (if any)
Supports database-specific queries for: SQL Server, PostgreSQL, Oracle, and MySQL/MariaDB.
This endpoint is useful for diagnosing connectivity issues, especially when the database is behind a load balancer and you need to identify which node is responding or experiencing SSL certificate issues.
Note: This endpoint may take a long time to respond if the database connection is slow or experiencing issues. The response time depends on the connection pool timeout and JDBC driver settings.
Authentication is Required
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (5)
- response_time_ms
- response_time_ms
- status
- database_name
- database_name
- server_ip
- server_ip
- server_name
- server_name
Example success response
{
"status": "ok",
"server_name": "DBSERVER01",
"server_ip": "10.0.1.50",
"database_name": "obp_adapter",
"response_time_ms": 45
}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.