Edit an External MCP Connection

Organization-admin-only. Name and direct access changes preserve credentials. URL, authentication type, or credential-mode changes invalidate the old identity atomically. Secret fields are write-only optional replacements and are never returned. expectedUpdatedAt prevents stale edits.

PUT /v1/mcp-connections/{connectionId}

Edit an External MCP Connection

cURL

curl --request PUT \
  --url https://api.example.com/v1/mcp-connections/{connectionId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedUpdatedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "url": "<string>",
  "access": {
    "orgWide": false,
    "memberIds": [],
    "teamIds": []
  },
  "apiKey": "<string>",
  "authorizationServerIssuer": "<string>",
  "requestedScopes": [
    "<string>"
  ]
}
'

import requests

url = "https://api.example.com/v1/mcp-connections/{connectionId}"

payload = {
    "expectedUpdatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "url": "<string>",
    "access": {
        "orgWide": False,
        "memberIds": [],
        "teamIds": []
    },
    "apiKey": "<string>",
    "authorizationServerIssuer": "<string>",
    "requestedScopes": ["<string>"]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    expectedUpdatedAt: '2023-11-07T05:31:56Z',
    name: '<string>',
    url: '<string>',
    access: {orgWide: false, memberIds: [], teamIds: []},
    apiKey: '<string>',
    authorizationServerIssuer: '<string>',
    requestedScopes: ['<string>']
  })
};

fetch('https://api.example.com/v1/mcp-connections/{connectionId}', 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/v1/mcp-connections/{connectionId}",
  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([
    'expectedUpdatedAt' => '2023-11-07T05:31:56Z',
    'name' => '<string>',
    'url' => '<string>',
    'access' => [
        'orgWide' => false,
        'memberIds' => [
                
        ],
        'teamIds' => [
                
        ]
    ],
    'apiKey' => '<string>',
    'authorizationServerIssuer' => '<string>',
    'requestedScopes' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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/v1/mcp-connections/{connectionId}"

	payload := strings.NewReader("{\n  \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"access\": {\n    \"orgWide\": false,\n    \"memberIds\": [],\n    \"teamIds\": []\n  },\n  \"apiKey\": \"<string>\",\n  \"authorizationServerIssuer\": \"<string>\",\n  \"requestedScopes\": [\n    \"<string>\"\n  ]\n}")

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

	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/v1/mcp-connections/{connectionId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"access\": {\n    \"orgWide\": false,\n    \"memberIds\": [],\n    \"teamIds\": []\n  },\n  \"apiKey\": \"<string>\",\n  \"authorizationServerIssuer\": \"<string>\",\n  \"requestedScopes\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"access\": {\n    \"orgWide\": false,\n    \"memberIds\": [],\n    \"teamIds\": []\n  },\n  \"apiKey\": \"<string>\",\n  \"authorizationServerIssuer\": \"<string>\",\n  \"requestedScopes\": [\n    \"<string>\"\n  ]\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "connected": true,
  "connectedAt": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "connectedForMe": true,
  "requiredBy": [
    {
      "pluginId": "<string>",
      "name": "<string>"
    }
  ],
  "identityManagedBy": [
    {
      "pluginId": "<string>",
      "name": "<string>"
    }
  ],
  "access": {
    "orgWide": true,
    "memberIds": [
      "<string>"
    ],
    "teamIds": [
      "<string>"
    ]
  },
  "identityChanged": true,
  "reconnectionRequired": true,
  "createdByName": "<string>",
  "needsReconnect": true,
  "credentialHealthCheckedAt": "2023-11-07T05:31:56Z",
  "issuerReviewRequired": true,
  "missingFeatures": [
    "<string>"
  ],
  "externalAccountId": "<string>",
  "grantedScopes": [
    "<string>"
  ],
  "tenantId": "<string>",
  "authPolicyConfirmed": true,
  "authTypeMismatch": true,
  "oauthClientConfigured": true,
  "oauthClientRequired": true,
  "setupRequired": true,
  "oauthClientId": "<string>",
  "oauthCallbackUrl": "<string>",
  "oauthSharedCallbackUrl": "<string>",
  "oauthClientMetadataUrl": "<string>",
  "authorizationServerIssuer": "<string>",
  "requestedScopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "details": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "error": "<string>"
}

{
  "reason": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "diagnostic": {
    "referenceId": "<string>",
    "category": "<string>",
    "code": "<string>",
    "retryable": true,
    "operatorAction": "<string>",
    "message": "<string>",
    "httpStatus": 349,
    "outbound": {
      "origin": "<string>",
      "pathHash": "<string>"
    },
    "providerRequestId": "<string>",
    "providerStatus": 0,
    "providerCode": "<string>",
    "payloadBytes": 0,
    "jsonRpcCode": 0,
    "connectUrl": "<string>"
  }
}

Path Parameters

connectionId · string<typeid> · required

Den TypeID with 'emc_' prefix and a 26-character base32 suffix.

Required string length: 30

Pattern: ^emc_.*

Body

application/json

expectedUpdatedAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

name · string · required

Required string length: 1 - 255

url · string<uri> · required

Maximum string length: 2048

authType · enum<string> · required

Available options: oauth, apikey, none

credentialMode · enum<string> · required

Available options: shared, per_member

access · object · required

Show child attributes

apiKey · string

Required string length: 1 - 4096

oauthClient · object

Show child attributes

authorizationServerIssuer · string<uri> | null

Maximum string length: 2048

requestedScopes · string[]

Maximum array length: 100

Required string length: 1 - 255

Response

200

application/json

Connection updated.

id · string · required

name · string · required

url · string · required

authType · enum<string> · required

Available options: oauth, apikey, none

credentialMode · enum<string> · required

Available options: shared, per_member

connected · boolean · required

connectedAt · string | null · required

updatedAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

connectedForMe · boolean · required

requiredBy · object[] · required

Show child attributes

identityManagedBy · object[] · required

Show child attributes

access · object | null · required

Show child attributes

identityChanged · boolean · required

reconnectionRequired · boolean · required

createdByName · string | null

needsReconnect · boolean

credentialHealth · enum<string>

Available options: unknown, ready, reconnect_required

credentialHealthReason · enum<string> | null

Available options: authorization_rejected, credential_expired, post_authorization_validation_failed

credentialHealthCheckedAt · string<date-time> | null

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

issuerReviewRequired · boolean

reconnectActionOwner · enum<string> | null

Available options: member, organization_admin

missingFeatures · string[]

externalAccountId · string | null

grantedScopes · string[]

tenantId · string | null

requiredAuthType · enum<string> | null

Available options: oauth, apikey, none

authPolicyConfirmed · boolean

authTypeMismatch · boolean

oauthClientConfigured · boolean

oauthClientRequired · boolean

setupRequired · boolean

oauthClientId · string | null

oauthCallbackUrl · string | null

oauthSharedCallbackUrl · string | null

oauthClientMetadataUrl · string | null

oauthCallbackMode · enum<string> | null

Available options: shared-v1, isolated-v1, legacy-v1

oauthRegistrationSource · enum<string> | null

Available options: pre-registered, client-metadata, dynamic

authorizationServerIssuer · string | null

requestedScopes · string[]