Onboarding
Test a database connection
Validates the URL scheme, creates a temporary connection, runs a health check, and returns the result. The connection is not persisted. Requires managed auth mode and an authenticated session.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:3001/api/v1/onboarding/test-connection" \ -H "Content-Type: application/json" \ -d '{ "url": "string" }'{
"status": "string",
"latencyMs": 0,
"dbType": "string",
"maskedUrl": "string"
}{
"error": "string",
"message": "string",
"requestId": "string"
}{
"property1": null,
"property2": null
}{
"error": "string",
"message": "string",
"requestId": "string"
}{
"error": "string",
"message": "string",
"requestId": "string",
"details": [
null
]
}{
"property1": null,
"property2": null
}{
"error": "string",
"message": "string",
"requestId": "string"
}