Update connector
curl --request POST \
--url https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"connector": {
"name": "<string>",
"type": "<string>",
"enabled": true,
"url": "<string>",
"auth": {
"type": "<string>",
"token": "<string>",
"headers": {},
"audience": "<string>",
"scopes": "<string>",
"idpId": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthAuthorizeEndpoint": "<string>",
"oauthTokenEndpoint": "<string>",
"tokenSet": true,
"headersSet": true,
"oauthClientSecretSet": true,
"clearCredentials": true,
"headerKeys": [
"<string>"
],
"clearHeaders": true
},
"stdio": {
"command": "<string>",
"args": [
"<string>"
]
},
"description": "<string>",
"serverJson": "<string>",
"authMethod": "<string>",
"allowUserOverride": true,
"kind": "<string>",
"iconUrl": "<string>",
"spec": "<string>",
"specFetchedAt": "<string>",
"displayName": "<string>",
"configFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"secret": true,
"scope": "<string>"
}
],
"id": "<string>",
"oauthRedirectUri": "<string>",
"oauthCallbackKey": "<string>"
},
"organizationId": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
connector: {
name: '<string>',
type: '<string>',
enabled: true,
url: '<string>',
auth: {
type: '<string>',
token: '<string>',
headers: {},
audience: '<string>',
scopes: '<string>',
idpId: '<string>',
oauthClientId: '<string>',
oauthClientSecret: '<string>',
oauthAuthorizeEndpoint: '<string>',
oauthTokenEndpoint: '<string>',
tokenSet: true,
headersSet: true,
oauthClientSecretSet: true,
clearCredentials: true,
headerKeys: ['<string>'],
clearHeaders: true
},
stdio: {command: '<string>', args: ['<string>']},
description: '<string>',
serverJson: '<string>',
authMethod: '<string>',
allowUserOverride: true,
kind: '<string>',
iconUrl: '<string>',
spec: '<string>',
specFetchedAt: '<string>',
displayName: '<string>',
configFields: [
{
key: '<string>',
label: '<string>',
description: '<string>',
required: true,
secret: true,
scope: '<string>'
}
],
id: '<string>',
oauthRedirectUri: '<string>',
oauthCallbackKey: '<string>'
},
organizationId: '<string>'
})
};
fetch('https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector"
payload = {
"name": "<string>",
"connector": {
"name": "<string>",
"type": "<string>",
"enabled": True,
"url": "<string>",
"auth": {
"type": "<string>",
"token": "<string>",
"headers": {},
"audience": "<string>",
"scopes": "<string>",
"idpId": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthAuthorizeEndpoint": "<string>",
"oauthTokenEndpoint": "<string>",
"tokenSet": True,
"headersSet": True,
"oauthClientSecretSet": True,
"clearCredentials": True,
"headerKeys": ["<string>"],
"clearHeaders": True
},
"stdio": {
"command": "<string>",
"args": ["<string>"]
},
"description": "<string>",
"serverJson": "<string>",
"authMethod": "<string>",
"allowUserOverride": True,
"kind": "<string>",
"iconUrl": "<string>",
"spec": "<string>",
"specFetchedAt": "<string>",
"displayName": "<string>",
"configFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": True,
"secret": True,
"scope": "<string>"
}
],
"id": "<string>",
"oauthRedirectUri": "<string>",
"oauthCallbackKey": "<string>"
},
"organizationId": "<string>"
}
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"connector\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"enabled\": true,\n \"url\": \"<string>\",\n \"auth\": {\n \"type\": \"<string>\",\n \"token\": \"<string>\",\n \"headers\": {},\n \"audience\": \"<string>\",\n \"scopes\": \"<string>\",\n \"idpId\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"oauthAuthorizeEndpoint\": \"<string>\",\n \"oauthTokenEndpoint\": \"<string>\",\n \"tokenSet\": true,\n \"headersSet\": true,\n \"oauthClientSecretSet\": true,\n \"clearCredentials\": true,\n \"headerKeys\": [\n \"<string>\"\n ],\n \"clearHeaders\": true\n },\n \"stdio\": {\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"serverJson\": \"<string>\",\n \"authMethod\": \"<string>\",\n \"allowUserOverride\": true,\n \"kind\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"spec\": \"<string>\",\n \"specFetchedAt\": \"<string>\",\n \"displayName\": \"<string>\",\n \"configFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"secret\": true,\n \"scope\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"oauthRedirectUri\": \"<string>\",\n \"oauthCallbackKey\": \"<string>\"\n },\n \"organizationId\": \"<string>\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"connector\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"enabled\": true,\n \"url\": \"<string>\",\n \"auth\": {\n \"type\": \"<string>\",\n \"token\": \"<string>\",\n \"headers\": {},\n \"audience\": \"<string>\",\n \"scopes\": \"<string>\",\n \"idpId\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"oauthAuthorizeEndpoint\": \"<string>\",\n \"oauthTokenEndpoint\": \"<string>\",\n \"tokenSet\": true,\n \"headersSet\": true,\n \"oauthClientSecretSet\": true,\n \"clearCredentials\": true,\n \"headerKeys\": [\n \"<string>\"\n ],\n \"clearHeaders\": true\n },\n \"stdio\": {\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"serverJson\": \"<string>\",\n \"authMethod\": \"<string>\",\n \"allowUserOverride\": true,\n \"kind\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"spec\": \"<string>\",\n \"specFetchedAt\": \"<string>\",\n \"displayName\": \"<string>\",\n \"configFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"secret\": true,\n \"scope\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"oauthRedirectUri\": \"<string>\",\n \"oauthCallbackKey\": \"<string>\"\n },\n \"organizationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
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))
}{
"connector": {
"name": "<string>",
"type": "<string>",
"enabled": true,
"url": "<string>",
"auth": {
"type": "<string>",
"token": "<string>",
"headers": {},
"audience": "<string>",
"scopes": "<string>",
"idpId": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthAuthorizeEndpoint": "<string>",
"oauthTokenEndpoint": "<string>",
"tokenSet": true,
"headersSet": true,
"oauthClientSecretSet": true,
"clearCredentials": true,
"headerKeys": [
"<string>"
],
"clearHeaders": true
},
"stdio": {
"command": "<string>",
"args": [
"<string>"
]
},
"description": "<string>",
"serverJson": "<string>",
"authMethod": "<string>",
"allowUserOverride": true,
"kind": "<string>",
"iconUrl": "<string>",
"spec": "<string>",
"specFetchedAt": "<string>",
"displayName": "<string>",
"configFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"secret": true,
"scope": "<string>"
}
],
"id": "<string>",
"oauthRedirectUri": "<string>",
"oauthCallbackKey": "<string>"
}
}{
"code": "not_found",
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Update connector
Update a connector
Requires the connectors:write scope.
POST
/
conduit.v1.ConduitService
/
UpdateConnector
Update connector
curl --request POST \
--url https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"connector": {
"name": "<string>",
"type": "<string>",
"enabled": true,
"url": "<string>",
"auth": {
"type": "<string>",
"token": "<string>",
"headers": {},
"audience": "<string>",
"scopes": "<string>",
"idpId": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthAuthorizeEndpoint": "<string>",
"oauthTokenEndpoint": "<string>",
"tokenSet": true,
"headersSet": true,
"oauthClientSecretSet": true,
"clearCredentials": true,
"headerKeys": [
"<string>"
],
"clearHeaders": true
},
"stdio": {
"command": "<string>",
"args": [
"<string>"
]
},
"description": "<string>",
"serverJson": "<string>",
"authMethod": "<string>",
"allowUserOverride": true,
"kind": "<string>",
"iconUrl": "<string>",
"spec": "<string>",
"specFetchedAt": "<string>",
"displayName": "<string>",
"configFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"secret": true,
"scope": "<string>"
}
],
"id": "<string>",
"oauthRedirectUri": "<string>",
"oauthCallbackKey": "<string>"
},
"organizationId": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
connector: {
name: '<string>',
type: '<string>',
enabled: true,
url: '<string>',
auth: {
type: '<string>',
token: '<string>',
headers: {},
audience: '<string>',
scopes: '<string>',
idpId: '<string>',
oauthClientId: '<string>',
oauthClientSecret: '<string>',
oauthAuthorizeEndpoint: '<string>',
oauthTokenEndpoint: '<string>',
tokenSet: true,
headersSet: true,
oauthClientSecretSet: true,
clearCredentials: true,
headerKeys: ['<string>'],
clearHeaders: true
},
stdio: {command: '<string>', args: ['<string>']},
description: '<string>',
serverJson: '<string>',
authMethod: '<string>',
allowUserOverride: true,
kind: '<string>',
iconUrl: '<string>',
spec: '<string>',
specFetchedAt: '<string>',
displayName: '<string>',
configFields: [
{
key: '<string>',
label: '<string>',
description: '<string>',
required: true,
secret: true,
scope: '<string>'
}
],
id: '<string>',
oauthRedirectUri: '<string>',
oauthCallbackKey: '<string>'
},
organizationId: '<string>'
})
};
fetch('https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector"
payload = {
"name": "<string>",
"connector": {
"name": "<string>",
"type": "<string>",
"enabled": True,
"url": "<string>",
"auth": {
"type": "<string>",
"token": "<string>",
"headers": {},
"audience": "<string>",
"scopes": "<string>",
"idpId": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthAuthorizeEndpoint": "<string>",
"oauthTokenEndpoint": "<string>",
"tokenSet": True,
"headersSet": True,
"oauthClientSecretSet": True,
"clearCredentials": True,
"headerKeys": ["<string>"],
"clearHeaders": True
},
"stdio": {
"command": "<string>",
"args": ["<string>"]
},
"description": "<string>",
"serverJson": "<string>",
"authMethod": "<string>",
"allowUserOverride": True,
"kind": "<string>",
"iconUrl": "<string>",
"spec": "<string>",
"specFetchedAt": "<string>",
"displayName": "<string>",
"configFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": True,
"secret": True,
"scope": "<string>"
}
],
"id": "<string>",
"oauthRedirectUri": "<string>",
"oauthCallbackKey": "<string>"
},
"organizationId": "<string>"
}
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"connector\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"enabled\": true,\n \"url\": \"<string>\",\n \"auth\": {\n \"type\": \"<string>\",\n \"token\": \"<string>\",\n \"headers\": {},\n \"audience\": \"<string>\",\n \"scopes\": \"<string>\",\n \"idpId\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"oauthAuthorizeEndpoint\": \"<string>\",\n \"oauthTokenEndpoint\": \"<string>\",\n \"tokenSet\": true,\n \"headersSet\": true,\n \"oauthClientSecretSet\": true,\n \"clearCredentials\": true,\n \"headerKeys\": [\n \"<string>\"\n ],\n \"clearHeaders\": true\n },\n \"stdio\": {\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"serverJson\": \"<string>\",\n \"authMethod\": \"<string>\",\n \"allowUserOverride\": true,\n \"kind\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"spec\": \"<string>\",\n \"specFetchedAt\": \"<string>\",\n \"displayName\": \"<string>\",\n \"configFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"secret\": true,\n \"scope\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"oauthRedirectUri\": \"<string>\",\n \"oauthCallbackKey\": \"<string>\"\n },\n \"organizationId\": \"<string>\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://conduit.example.com/conduit.v1.ConduitService/UpdateConnector"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"connector\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"enabled\": true,\n \"url\": \"<string>\",\n \"auth\": {\n \"type\": \"<string>\",\n \"token\": \"<string>\",\n \"headers\": {},\n \"audience\": \"<string>\",\n \"scopes\": \"<string>\",\n \"idpId\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"oauthAuthorizeEndpoint\": \"<string>\",\n \"oauthTokenEndpoint\": \"<string>\",\n \"tokenSet\": true,\n \"headersSet\": true,\n \"oauthClientSecretSet\": true,\n \"clearCredentials\": true,\n \"headerKeys\": [\n \"<string>\"\n ],\n \"clearHeaders\": true\n },\n \"stdio\": {\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"serverJson\": \"<string>\",\n \"authMethod\": \"<string>\",\n \"allowUserOverride\": true,\n \"kind\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"spec\": \"<string>\",\n \"specFetchedAt\": \"<string>\",\n \"displayName\": \"<string>\",\n \"configFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"secret\": true,\n \"scope\": \"<string>\"\n }\n ],\n \"id\": \"<string>\",\n \"oauthRedirectUri\": \"<string>\",\n \"oauthCallbackKey\": \"<string>\"\n },\n \"organizationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
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))
}{
"connector": {
"name": "<string>",
"type": "<string>",
"enabled": true,
"url": "<string>",
"auth": {
"type": "<string>",
"token": "<string>",
"headers": {},
"audience": "<string>",
"scopes": "<string>",
"idpId": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthAuthorizeEndpoint": "<string>",
"oauthTokenEndpoint": "<string>",
"tokenSet": true,
"headersSet": true,
"oauthClientSecretSet": true,
"clearCredentials": true,
"headerKeys": [
"<string>"
],
"clearHeaders": true
},
"stdio": {
"command": "<string>",
"args": [
"<string>"
]
},
"description": "<string>",
"serverJson": "<string>",
"authMethod": "<string>",
"allowUserOverride": true,
"kind": "<string>",
"iconUrl": "<string>",
"spec": "<string>",
"specFetchedAt": "<string>",
"displayName": "<string>",
"configFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"secret": true,
"scope": "<string>"
}
],
"id": "<string>",
"oauthRedirectUri": "<string>",
"oauthCallbackKey": "<string>"
}
}{
"code": "not_found",
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Define the version of the Connect protocol
Available options:
1 Define the timeout, in ms
Body
application/json
Response
Success
ConnectorConfig is a workspace tool source of some kind (MCP / GraphQL /
OpenAPI), keyed by kind. Despite the historical field set (type, stdio,
server_json — MCP-specific), this describes any connector; non-MCP kinds
leave the MCP-only fields empty.
Show child attributes
Show child attributes
Was this page helpful?