Update a connection

Deprecated

PATCH

/v2/connections/:connectionId

PATCH

/v2/connections/:connectionId

curl -X PATCH https://api.sigmacomputing.com/v2/connections/connectionId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "organizationId": "string",
  "connectionId": "string",
  "isSample": true,
  "isAuditLog": true,
  "lastActiveAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "type": "string",
  "useOauth": true,
  "createdBy": "string",
  "updatedBy": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "isArchived": true,
  "account": "string",
  "warehouse": "string",
  "user": "string",
  "httpPath": "string",
  "role": "string",
  "timeout": {
    "default": 1.1,
    "worksheet": 1.1,
    "dashboard": 1.1,
    "download": 1.1
  },
  "poolSizes": {
    "isPoolConfigured": true,
    "catalogPoolSize": 1.1,
    "resultPoolSize": 1.1,
    "schedulePoolSize": 1.1
  },
  "writeAccess": true,
  "friendlyName": true,
  "writebacks": [
    {
      "database": "string",
      "schema": "string",
      "writebackSchemaId": "string",
      "description": "string"
    }
  ],
  "writebackSchemas": [
    {
      "database": "string",
      "schema": "string",
      "writebackSchemaId": "string",
      "description": "string"
    }
  ],
  "inputTableAuditLogSchema": {
    "database": "string",
    "schema": "string",
    "writebackSchemaId": "string"
  },
  "materializationWarehouse": "string",
  "exportsWarehouse": "string",
  "oauthMetadataUrl": "string",
  "oauthClientId": "string",
  "oauthScopes": [
    "string"
  ],
  "oauthIdpType": "aws_databricks",
  "oauthUsePkce": true,
  "oauthUseJwt": true,
  "oauthAudience": "string",
  "isIndependentOAuth": true,
  "userAttributes": {
    "role": "string",
    "warehouse": "string"
  },
  "roleSwitching": "allRoles",
  "enableHiveMetastore": true,
  "usePython": true,
  "pythonComputeClusterId": "string"
}

Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the PUT endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

connectionIdstringRequired

Request

The request body.

namestringOptional

useOauthbooleanOptional

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

isArchivedbooleanOptional

Whether the connection is archived

accountstringOptional

Account associated with the connection

warehousestringOptional

Warehouse associated with the connection

userstringOptional

User associated with the connection

httpPathstringOptional

For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path.

rolestringOptional

Role used by the connection user

timeoutobjectOptional

Timeout settings for the connection, with a default value in seconds

poolSizesobjectOptional

Pool sizes for the connection, such as for catalogPoolSize or schedulePoolSize

writeAccessbooleanOptional

friendlyNamebooleanOptional

Whether friendly names are enabled for this connection

writebackslist of objectsOptional

Configure write-back for non-OAuth connections

writebackSchemaslist of objectsOptional

Configure write-back for OAuth connections

inputTableAuditLogSchemaobjectOptional

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

materializationWarehousestringOptional

Warehouse used to run materialization jobs

exportsWarehousestringOptional

Warehouse used to run export jobs

oauthMetadataUrlstringOptional

OAuth metadata URL configured directly on this connection.

oauthClientIdstringOptional

Client ID configured directly on this connection.

oauthScopeslist of stringsOptional

OAuth scopes configured directly on this connection.

oauthIdpTypeenumOptional

OAuth provider type configured or inferred for this connection.

oauthUsePkceboolean or nullOptional

Whether this connection-level OAuth configuration uses PKCE.

oauthUseJwtboolean or nullOptional

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

oauthAudiencestringOptional

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

isIndependentOAuthbooleanOptional

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

userAttributesobjectOptional

User attributes associated with the connection

roleSwitchingenumOptional

Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections.

Allowed values:

enableHiveMetastorebooleanOptional

Whether this Databricks connection exposes the hive_metastore catalog in Sigma. Only relevant for Databricks connections.

usePythonbooleanOptional

pythonComputeClusterIdstringOptional

ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.