> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://help.sigmacomputing.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server.

# Update a connection

PATCH https://api.sigmacomputing.com/v2/connections/{connectionId}
Content-Type: application/json

Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the [PUT endpoint](https://help.sigmacomputing.com/reference/updateconnection).

Reference: https://help.sigmacomputing.com/reference/update-connection

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.sigmacomputing.com` (Server for GCP (US) hosted organizations, default)
- `https://api.sa.gcp.sigmacomputing.com` (Server for GCP (KSA) hosted organizations)
- `https://aws-api.sigmacomputing.com` (Server for AWS US (West) hosted organizations)
- `https://api.us-a.aws.sigmacomputing.com` (Server for AWS US (East) hosted organizations)
- `https://api.ca.aws.sigmacomputing.com` (Server for AWS Canada hosted organizations)
- `https://api.eu.aws.sigmacomputing.com` (Server for AWS Europe hosted organizations)
- `https://api.au.aws.sigmacomputing.com` (Server for AWS Australia and APAC hosted organizations)
- `https://api.uk.aws.sigmacomputing.com` (Server for AWS UK hosted organizations)
- `https://api.us.azure.sigmacomputing.com` (Server for Azure US hosted organizations)
- `https://api.eu.azure.sigmacomputing.com` (Server for Azure Europe hosted organizations)
- `https://api.ca.azure.sigmacomputing.com` (Server for Azure Canada hosted organizations)
- `https://api.uk.azure.sigmacomputing.com` (Server for Azure United Kingdom hosted organizations)
- `https://api.au.azure.sigmacomputing.com` (Server for Azure Australia hosted organizations)

## Request

### Path parameters

- `connectionId` (string, required)

### Body (application/json)

- `name` (string, optional)
- `useOauth` (boolean, optional)

## Response

### 200

The response body.

- `organizationId` (string, required) — Unique identifier of the organization
- `connectionId` (string, required) — Unique identifier of the connection
- `isSample` (boolean, required) — Whether the connection is the Sigma sample data connection
- `isAuditLog` (boolean, required) — Whether audit logging is enabled
- `lastActiveAt` (datetime, required) — Last activity date and time
- `name` (string, required) — Name of the connection
- `type` (string, required) — Type of the connection (e.g., "bigQuery")
- `useOauth` (boolean, required) — Whether OAuth is used
- `createdBy` (string, required) — Identifier of the user who created this connection
- `updatedBy` (string, required) — Identifier of the user or process that last updated this connection
- `createdAt` (datetime, required) — When the connection was created
- `updatedAt` (datetime, required) — When the connection was last updated
- `isArchived` (boolean, optional) — Whether the connection is archived
- `account` (string, optional) — Account associated with the connection
- `warehouse` (string, optional) — Warehouse associated with the connection
- `user` (string, optional) — User associated with the connection
- `role` (string, optional) — Role used by the connection user
- `timeout` (object, optional) — Timeout settings for the connection, with a default value in seconds
  - `default` (double, required)
  - `worksheet` (double, optional)
  - `dashboard` (double, optional)
  - `download` (double, optional)
- `poolSizes` (object, optional) — Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
  - `isPoolConfigured` (boolean, optional)
  - `adhocPoolSize` (double, optional)
  - `catalogPoolSize` (double, optional)
  - `resultPoolSize` (double, optional)
  - `schedulePoolSize` (double, optional)
- `writeAccess` (boolean, optional)
- `friendlyName` (boolean, optional) — Whether friendly names are enabled for this connection
- `writebacks` (list of object, optional) — Configure write-back for non-OAuth connections
  - `database` (string, required) — Database, catalog, or top-level object to contain tables written back to the data platform
  - `schema` (string, required) — Schema, database, or second-level object to contain tables written back to the data platform
  - `writebackSchemaId` (string, optional) — Unique identifier of the writebackSchema
  - `description` (string, optional) — Description for the write-back destination.
- `writebackSchemas` (list of object, optional) — Configure write-back for OAuth connections
  - `database` (string, required) — Database, catalog, or top-level object to contain tables written back to the data platform
  - `schema` (string, required) — Schema, database, or second-level object to contain tables written back to the data platform
  - `writebackSchemaId` (string, optional) — Unique identifier of the writebackSchema
  - `description` (string, optional) — Description for the write-back destination.
- `inputTableAuditLogSchema` (object, optional) — Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
  - `database` (string, required) — Database, catalog, or top-level object to contain tables written back to the data platform
  - `schema` (string, required) — Schema, database, or second-level object to contain tables written back to the data platform
  - `writebackSchemaId` (string, optional) — Unique identifier of the writebackSchema
- `materializationWarehouse` (string, optional) — Warehouse used to run materialization jobs
- `exportsWarehouse` (string, optional) — Warehouse used to run export jobs
- `oauthMetadataUrl` (string, optional) — OAuth metadata URL configured directly on this connection.
- `oauthClientId` (string, optional) — Client ID configured directly on this connection.
- `oauthScopes` (list of string, optional) — OAuth scopes configured directly on this connection.
- `oauthIdpType` (enum or enum or enum or enum or enum or enum or enum or enum or enum or enum, optional) — OAuth provider type configured or inferred for this connection.
- `oauthUsePkce` (boolean, optional, nullable) — Whether this connection-level OAuth configuration uses PKCE.
- `oauthUseJwt` (boolean, optional, nullable) — Whether this connection-level OAuth configuration uses JWT bearer token authentication.
- `oauthAudience` (string, optional) — Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery.
- `isIndependentOAuth` (boolean, optional) — Whether this connection uses connection-level OAuth instead of organization-level OAuth.
- `userAttributes` (object, optional) — User attributes associated with the connection
  - `role` (string, optional)
  - `warehouse` (string, optional)
- `roleSwitching` (enum, optional) — Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.
  - Allowed values: `allRoles`, `disabled`

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "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",
  "role": "string",
  "timeout": {
    "default": 1.1,
    "worksheet": 1.1,
    "dashboard": 1.1,
    "download": 1.1
  },
  "poolSizes": {
    "isPoolConfigured": true,
    "adhocPoolSize": 1.1,
    "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"
}
```

**SDK Code**

```python
import requests

url = "https://api.sigmacomputing.com/v2/connections/connectionId"

payload = {}
headers = {
    "Authorization": "<token>.",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sigmacomputing.com/v2/connections/connectionId';
const options = {
  method: 'PATCH',
  headers: {Authorization: '<token>.', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sigmacomputing.com/v2/connections/connectionId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<token>.")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sigmacomputing.com/v2/connections/connectionId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<token>.'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.sigmacomputing.com/v2/connections/connectionId")
  .header("Authorization", "<token>.")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.sigmacomputing.com/v2/connections/connectionId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => '<token>.',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sigmacomputing.com/v2/connections/connectionId");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "<token>.");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<token>.",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/connections/connectionId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```