Update connector

Update a connector

PUT /connection/connectors/{uuid}

Update connector

cURL

curl --request PUT \
  --url https://api.getcargo.io/v1/connection/connectors/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "isDefault": true,
  "config": {},
  "rateLimit": {
    "max": 123
  },
  "cacheTtlMilliseconds": 123
}
'

import requests

url = "https://api.getcargo.io/v1/connection/connectors/{uuid}"

payload = {
    "name": "<string>",
    "isDefault": True,
    "config": {},
    "rateLimit": { "max": 123 },
    "cacheTtlMilliseconds": 123
}
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({
    name: '<string>',
    isDefault: true,
    config: {},
    rateLimit: {max: 123},
    cacheTtlMilliseconds: 123
  })
};

fetch('https://api.getcargo.io/v1/connection/connectors/{uuid}', 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.getcargo.io/v1/connection/connectors/{uuid}",
  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([
    'name' => '<string>',
    'isDefault' => true,
    'config' => [
        
    ],
    'rateLimit' => [
        'max' => 123
    ],
    'cacheTtlMilliseconds' => 123
  ]),
  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.getcargo.io/v1/connection/connectors/{uuid}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"isDefault\": true,\n  \"config\": {},\n  \"rateLimit\": {\n    \"max\": 123\n  },\n  \"cacheTtlMilliseconds\": 123\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.getcargo.io/v1/connection/connectors/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"isDefault\": true,\n  \"config\": {},\n  \"rateLimit\": {\n    \"max\": 123\n  },\n  \"cacheTtlMilliseconds\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/connection/connectors/{uuid}")

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  \"name\": \"<string>\",\n  \"isDefault\": true,\n  \"config\": {},\n  \"rateLimit\": {\n    \"max\": 123\n  },\n  \"cacheTtlMilliseconds\": 123\n}"

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

200

{
  "connector": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "rateLimit": {
      "max": 123
    },
    "cacheTtlMilliseconds": 123,
    "integrationSlug": "<string>",
    "isDefault": true,
    "playsCount": 123,
    "toolsCount": 123,
    "modelsCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "useCredits": true,
    "config": null
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

uuid · string<uuid> · required

Connector identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

name · string

Connector name.

isDefault · boolean

Whether this connector is the default for its integration. Setting it to true clears the previous default.

config · Config · object | null

Connector configuration.

Show child attributes

rateLimit · Rate limit · object | null

Rate limit configuration.

Show child attributes

cacheTtlMilliseconds · number | null

Cache time-to-live in milliseconds.

Response

200

application/json

Successful response

connector · Connector · object · required

Updated connector details.

Connector

Connector

Show child attributes