connections

Rename and/or re-configure a connection.

Updates the connection's name and/or non-secret config under optimistic concurrency (pass the current version). type and authMethod are immutable — changing them would orphan stored credentials or grants, so delete and recreate instead. Credentials are never accepted here. Admin or above.

patch/v1/connections/{id}

Request

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

Request body

versioninteger required
namestring
configobject

Replaces the stored non-secret config. Omit to leave it unchanged.

catalogSyncEnabledboolean

Opt this connection in/out of the synced warehouse catalog (A3, DVT-1810). Omit to leave unchanged. Setting false synchronously wipes any persisted catalog for this connection in the same transaction as the version bump.

linkedBaseOptInboolean

Opt this connection in/out as an eligible base for kind='linked' sheets (DVT-2932, ADR-0078 D1). Omit to leave unchanged. true stamps linkedBaseOptInAt/linkedBaseOptInBy (now / the acting admin), making this connection usable as a linked sheet's baseConnectionId. false clears both back to null, revoking eligibility for future creates — it does not retroactively affect an already-created linked sheet's base binding. Admin or above, same as every other field on this endpoint.

Response

The updated connection (version incremented).

Changes

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