Get Connectors
GET /obp/v7.0.0/system/connectors
OBPv6.0.0-getConnectors No role required ConnectorSystemAPI
Get the list of connectors and their availability for method routing.
Returns a sorted list of all connectors with their availability status for use in Method Routing.
Response Fields
- connector_name - The name of the connector
- is_available_in_method_routing - Whether this connector can be used in Method Routing configuration.
This depends on the
connectorandstarConnector_supported_typesprops settings.
Available Connectors
The OBP-API supports multiple connectors for accessing banking data:
- mapped - Local database connector using Lift Mapper ORM
- akka_vDec2018 - Akka-based connector for remote banking systems
- rest_vMar2019 - REST connector for external APIs
- stored_procedure_vDec2019 - Stored procedure connector for database-native operations
- rabbitmq_vOct2024 - RabbitMQ message queue connector
- cardano_vJun2025 - Cardano blockchain connector
- ethereum_vSept2025 - Ethereum blockchain connector
- star - Star connector (special routing connector)
- proxy - Proxy connector (for testing)
- internal - Internal dynamic connector
Use Case
Use this endpoint to discover which connectors are available when configuring Method Routing.
A connector is available for method routing if it matches the connector prop setting,
or if connector=star and the connector is listed in starConnector_supported_types.
Authentication is Optional.
User Authentication is Optional. The User need not be logged in.
JSON response body fields (3)
- connector_name
- connectors
- connectors
- is_available_in_method_routing
- is_available_in_method_routing
Example success response
{
"connectors": [
{
"connector_name": "mapped",
"is_available_in_method_routing": true
},
{
"connector_name": "akka_vDec2018",
"is_available_in_method_routing": false
},
{
"connector_name": "rest_vMar2019",
"is_available_in_method_routing": true
},
{
"connector_name": "stored_procedure_vDec2019",
"is_available_in_method_routing": false
}
]
}Possible errors (1)
- OBP-50000: Unknown Error.