---
title: "Update a connection"
method: PATCH
path: "/connections/{connectionId}"
tags: ["Connections"]
---

# Update a connection

`PATCH /connections/{connectionId}`

## Request

- Base URL: `https://api.superglue.cloud/v1`
- URL: `https://api.superglue.cloud/v1/connections/{connectionId}`
- Auth: HTTP bearer

## Request body

- ConnectionUpdate
  - `expectedSystemId` string
  - `systemId` string
  - `name` string
  - `url` string, nullable
  - `authentication` ConnectionAuthentication
    - `type` 'none' | 'api_key' | 'basic_auth' | 'oauth2' | 'connection_string', required
    - `oauthClientMode` 'managed' | 'dynamic' | 'custom'
    - `grantType` 'authorization_code' | 'client_credentials' | 'password' | 'service_account' | 'custom'
    - `clientId` string
    - `clientSecret` string
    - `authUrl` string
    - `tokenUrl` string
    - `scopes` string[]
    - `protocol` string
    - `config` object
  - `authenticationPatch` object
  - `oauthAppId` string: Copies app configuration server-side before applying explicit authentication fields.
  - `credentials` object
  - `removeSecretNames` string[]
  - `tunnel` object, nullable
    - `tunnelId` string
  - `usageInstructions` string, nullable

## Response `200`

Updated connection

- object
  - `data` Connection, required
    - `id` string, required
    - `name` string, required
    - `systemId` string, required
    - `userId` string, required
    - `url` string
    - `authentication` ConnectionAuthentication, required
      - `type` 'none' | 'api_key' | 'basic_auth' | 'oauth2' | 'connection_string', required
      - `oauthClientMode` 'managed' | 'dynamic' | 'custom'
      - `grantType` 'authorization_code' | 'client_credentials' | 'password' | 'service_account' | 'custom'
      - `clientId` string
      - `clientSecret` string
      - `authUrl` string
      - `tokenUrl` string
      - `scopes` string[]
      - `protocol` string
      - `config` object
    - `matchingOAuthAppId` string: App whose client ID and secret match the stored configuration.
    - `credentialKeys` object[], required
      - `key` string, required
      - `hasValue` boolean, required
    - `isDefault` boolean
    - `isOwner` boolean
    - `permission` 'viewer' | 'editor'
    - `tunnel` object
      - `tunnelId` string
    - `usageInstructions` string
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

---

[API](https://skmtc.dev/superglue/apis/superglue-api.md) - [All operations](https://skmtc.dev/superglue/apis/superglue-api/llms.txt) - [OpenAPI document](https://skmtc.dev/superglue/apis/superglue-api/revisions/2d412a94bf09?raw)