Update Connection

Update a connection.

PUT /api/v1/connections/{connection_id}

Update Connection

cURL

curl --request PUT \
  --url https://api.example.com/api/v1/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "config": {}
}
'

import requests

url = "https://api.example.com/api/v1/connections/{connection_id}"

payload = {
    "label": "<string>",
    "config": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', config: {}})
};

fetch('https://api.example.com/api/v1/connections/{connection_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/connections/{connection_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'config' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/v1/connections/{connection_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"config\": {}\n}")

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/connections/{connection_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"config\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/connections/{connection_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"config\": {}\n}"

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

200

{
  "integration": "<string>",
  "id": "<string>",
  "credential_id": "<string>",
  "user_id": "<string>",
  "workspace_id": "<string>",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "label": "<string>",
  "config": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 string length: 255

config · Config · object | null

Updated configuration

status · enum<string> | null

Updated status

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

Response

200

application/json

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 string length: 255

config · Config · object

Integration-specific configuration