Update connection
PUT
/connections/{id}
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Connection ID
Request Bodyrequired
Section titled “Request Bodyrequired”object
name
string
description
string
credentials
Updated connection credentials (stored in Vault)
object
workspace_id
The owning workspace (for ownership/visibility re-checks).
string
workspace_ids
Workspaces this connection is shared into. If omitted, sharing is left unchanged. Must include the owning workspace_id.
Array<string>
metadata
Additional metadata
object
Responses
Section titled “Responses”Connection updated successfully
object
created_at
required
string format: date-time
created_by
required
string
updated_at
required
string format: date-time
updated_by
required
string
is_soft_deleted
required
boolean
version
required
number
encryption_key_name
required
string
encryption_key_version
number
vault_key_version
number
id
required
string
type
required
string
name
required
string
description
string
config
required
Job configuration stored in metadata database
object
workspace_id
required
The OWNING workspace. Controls who may modify the connection and change its sharing. Required.
string
workspace_ids
required
Full set of workspaces this connection is visible in and usable by. Always includes the owning workspace (workspace_id); non-empty.
Array<string>
metadata
required
Business sensitive metadata stored in metadata database
object
last_used_at
string format: date-time
consent_status
Consent status for admin-consent connections (e.g. Excel/SharePoint). Values: active, revoked.
string
Connection not found