Update a directconnection

put

https://api-public.klipfolio.com/v1.0-beta/direct_connections/{connectionId}

Requires the api:write scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

connectionId

string

required

Body Params

A public direct connection asset (metrics-service-backed).

version

const

enum

Allowed:

name

string

dataBaseType

string

required

Always required; identifies the connector type, e.g. 'postgresql', 'snowflake', 'redshift', 'bigquery', 'databricks', 'mariadb', 'aurora', 'azuresql', 'azuresynapse', 'dbt', 'cube', 'sample'. A dbt semantic-layer connection reports 'dbt', which is also how you create one. Each connector defines its own connectionFields parameter names.

ownerId

string

The user who owns the connection. Listed connections are the ones you own plus the ones shared across the account.

isShared

boolean

required

Whether the connection is shared with every user in the account.

connectionFields

object

Connector-specific configuration; field names vary per dataBaseType (e.g. postgresql uses user/_host/_port/_database/currentSchema). Populated only for a connection you own (and for the built-in sample connection) - an empty object for one shared across the account. Within your own connection, secret fields (password, private keys) are omitted rather than masked - but an update preserves any secret whose key it does not send, so a spec read from here can be sent straight back to PUT. Send a secret only to change it; sending it empty clears it.

Responses

200The updated directconnection.

defaultAn error response.