Skip to main content
POST
/
v1
/
discovery
/
aggregator-connections
/
test
Test aggregator connection credentials
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/discovery/aggregator-connections/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configName": "<string>"
}
'
{
  "configName": "<string>",
  "healthy": true
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Body

application/json
​
configName
string
required

Config name of the existing aggregator connection to test (tenant-scoped)

Minimum string length: 1
Example:

"pluggy-main"

​
vendor
enum<string>
required

Aggregator vendor: pluggy or belvo

Available options:
pluggy,
belvo
Example:

"pluggy"

Response

OK

​
configName
string
required

Connection config name that was tested

Example:

"pluggy-main"

​
healthy
boolean
required

Whether the live connectivity check passed with the sealed credential

Example:

true

​
vendor
enum<string>
required

Aggregator vendor the tested connection is bound to

Available options:
pluggy,
belvo
Example:

"pluggy"