Sigma REST APIConnections{connectionid}

Update a connection

View as MarkdownOpen in Claude
Update a specific connection by connection ID. When updating the connection, send any connection details that you want to keep. Retrieve the current state of a connection by calling the [/v2/connections/{connectionId}](https://help.sigmacomputing.com/reference/get-connection) endpoint. ### Usage notes - To restore a deleted connection, pass the `restore` parameter. - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

connectionIdstringRequired

Request

The request body.
detailsobjectRequired
namestringRequired
descriptionmap from strings to anyOptional
timeoutSecsdoubleOptional
useFriendlyNamesbooleanOptional
restorebooleanOptional

Response

The response body.
organizationIdstring
Unique identifier of the organization
connectionIdstring
Unique identifier of the connection
isSampleboolean
Whether the connection is the Sigma sample data connection
isAuditLogboolean
Whether audit logging is enabled
lastActiveAtdatetime
Last activity date and time
namestring
Name of the connection
typestring

Type of the connection (e.g., “bigQuery”)

useOauthboolean
Whether OAuth is used
createdBystring
Identifier of the user who created this connection
updatedBystring
Identifier of the user or process that last updated this connection
createdAtdatetime
When the connection was created
updatedAtdatetime
When the connection was last updated
isArchivedboolean
Whether the connection is archived
accountstring
Account associated with the connection
warehousestring
Warehouse associated with the connection
userstring
User associated with the connection
rolestring
Role used by the connection user
timeoutobject
Timeout settings for the connection, with a default value in seconds
poolSizesobject
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
writeAccessboolean
friendlyNameboolean
Whether friendly names are enabled for this connection
writebackslist of objects

Configure write-back for non-OAuth connections

writebackSchemaslist of objects

Configure write-back for OAuth connections

inputTableAuditLogSchemaobject

Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.

materializationWarehousestring
Warehouse used to run materialization jobs
exportsWarehousestring
Warehouse used to run export jobs
oauthMetadataUrlstring
OAuth metadata URL configured directly on this connection.
oauthClientIdstring
Client ID configured directly on this connection.
oauthScopeslist of strings
OAuth scopes configured directly on this connection.
oauthIdpTypeenum
OAuth provider type configured or inferred for this connection.
oauthUsePkceboolean or null

Whether this connection-level OAuth configuration uses PKCE.

oauthUseJwtboolean or null

Whether this connection-level OAuth configuration uses JWT bearer token authentication.

oauthAudiencestring
Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery.
isIndependentOAuthboolean

Whether this connection uses connection-level OAuth instead of organization-level OAuth.

userAttributesobject
User attributes associated with the connection
roleSwitchingenum
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.