Connections

Verify and create an external connection

Verifies within five seconds before saving an immutable credential version. Only public TLS endpoints are accepted. Database verification uses SELECT 1 in a read-only transaction. Secret rotation or revocation prevents new uses of the old connection. Create a new connection to adopt a new secret version.

post/v1/connections

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Request body

namestring required
kind'postgres' | 'neon' | 'supabase' | 'wandb' required
secretstring required

Existing tenant secret name or ID. Credential values are accepted only by POST /v1/secrets.

scope'read' | 'write' | 'readwrite'

Defaults to read for database kinds and write for wandb.

regionstring
branchstring
entitystring
projectstring
live_modeboolean

Requires a current team administrator and wandb write or readwrite scope.

Response

Success

namestring required
kind'postgres' | 'neon' | 'supabase' | 'wandb' required
scope'read' | 'write' | 'readwrite' required

Defaults to read for database kinds and write for wandb.

regionstring
branchstring
entitystring
projectstring
live_modeboolean required

Requires a current team administrator and wandb write or readwrite scope.

idstring required
secret_idstring required
secret_versioninteger required
egress_hostsstring[] required
verified_atstring date-time required
created_atstring date-time required
created_bystring required

Changes

No recorded changes to this operation across all 70 revisions of this API.