connections

Test an unsaved candidate connection (before it's created).

Probes a candidate connection — the warehouse config plus the raw secret the user just entered — without persisting anything (DVT-147). The engine opens the warehouse, runs a trivial probe (SELECT 1), and discards the credential; the raw secret travels API→engine the same way it does on credential save (the engine is the sole place plaintext is used to open a connection), and because there is no stored ciphertext the credential broker is not involved.

This lets the New-connection wizard catch a wrong account / key / role before committing the row — without it, a wrong-but-saved connection's config can only be fixed by delete-and-recreate. Admin or above.

A failed probe is a normal 200 result with ok: false and a (credential-free) error; 4xx is reserved for authorization and a malformed request. Secret-shaped keys are rejected in config (the credential belongs in secret).

post/v1/connections/test

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/connections/test
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

typestring required

Warehouse type (e.g. postgres, snowflake).

authMethodstring required

Auth method the driver opens the connection with (e.g. service_secret, service_keypair).

configobject

Non-secret connection config. Must not contain secret-shaped keys.

secretstring

The raw credential to test with (password or PEM key). Never persisted or echoed.

Response

The probe outcome (whether or not the candidate warehouse was reachable).

Changes

No recorded changes to this operation across all 1 revision of this API.