Homarr
Connect integrations

Test a saved integration using stored credentials

GET/api/integrations/{id}/test-connection

Requires full integration access. Runs the native connection check without changing saved configuration. Upstream authentication may establish a session. Success is a connection check, not widget or service acceptance. Failures expose only a safe category, not upstream errors or credentials.

ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/integrations/string/test-connection"
{  "success": true}