Skip to main content
PUT
/
api
/
v1
/
connections
/
{connection_id}
{
  "label": "<string>",
  "integration": "<string>",
  "integration_type": "connectors",
  "config": {},
  "id": "<string>",
  "credential_id": "<string>",
  "user_id": "<string>",
  "workspace_id": "<string>",
  "created_by": "<string>",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Workspace-Id
string | null

The workspace ID

Path Parameters

​
connection_id
string
required

Body

application/json

Schema for updating an existing connection.

​
label
string | null
Maximum length: 255
​
config
object | null

Updated configuration

​
status
enum<string> | null

Updated status

Available options:
active,
inactive,
testing,
error,
expired

Response

Successful Response

Schema for reading connection data.

​
integration
string
required

Integration name (slack, github, etc.)

​
integration_type
enum<string>
required

Type of integration (connectors, mcp, tool, model, storage, api, custom)

Available options:
connectors,
mcp,
tool,
model,
custom,
storage,
api
​
id
string
required
​
credential_id
string
required
​
user_id
string | null
required
​
workspace_id
string
required
​
created_by
string
required
​
status
enum<string>
required
Available options:
active,
inactive,
testing,
error,
expired
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
label
string | null

Human-readable label for the connection

Maximum length: 255
​
config
object

Integration-specific configuration