Update an MCP Server

PATCH

ai-gateway

mcp-servers

{id}

Update an MCP server

curl --request PATCH \
  --url https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_tools": [
    "get_weather"
  ],
  "status": "paused"
}
'

import requests

url = "https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id}"

payload = {
    "allowed_tools": ["get_weather"],
    "status": "paused"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({allowed_tools: ['get_weather'], status: 'paused'})
};

fetch('https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{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.knoxcall.com/v1/ai-gateway/mcp-servers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_tools' => [
        'get_weather'
    ],
    'status' => 'paused'
  ]),
  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.knoxcall.com/v1/ai-gateway/mcp-servers/{id}"

	payload := strings.NewReader("{\n  \"allowed_tools\": [\n    \"get_weather\"\n  ],\n  \"status\": \"paused\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_tools\": [\n    \"get_weather\"\n  ],\n  \"status\": \"paused\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_tools\": [\n    \"get_weather\"\n  ],\n  \"status\": \"paused\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "gateway_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "server_type": "upstream",
    "transport": "streamable_http",
    "upstream_url": "<string>",
    "allowed_tools": [
      "<string>"
    ],
    "pii_inspection": true,
    "pii_redact_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firewall_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "guardrail_webhook_url": "<string>",
    "guardrail_webhook_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "guardrail_webhook_mode": "off",
    "guardrail_webhook_timeout_ms": 5050,
    "guardrail_webhook_failure_action": "fail_open",
    "auth": {},
    "sandbox": true,
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "connect_url": "<string>",
    "resource": "<string>"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Partial update. Omitted fields are left as they are. The same write-time refusals apply as on create: a new upstream_url is re-validated through the SSRF chokepoint, a literal credential in auth.headers is refused, and userinfo in the URL (https://user:pass@host/) is rejected — a credential written into a URL lands in plaintext in every log line and error message that echoes it. Setting allowed_tools to [] takes every tool off the server. That is a valid thing to want and it is not a soft state: the server will advertise nothing. Requires the update capability on ai_gateway. See the control-plane overview for authentication, the {data, meta} envelope, pagination and error types.

Authorizations

Authorization

string

header

required

OAuth 2.1 authentication — recommended for new integrations. Access tokens (kc_ prefix) are minted at the root-host token endpoint https://api.knoxcall.com/oauth/token and passed as Authorization: Bearer <access_token>. Public clients must use PKCE with the authorization_code grant; confidential clients may use client_credentials. The first-party SDKs and the knoxcall login CLI handle token minting, caching, refresh, and DPoP for you.

Path Parameters

string<uuid>

required

The MCP server UUID.

Body

application/json

name

string

description

string | null

upstream_url

string<uri>

transport

enum<string>

Only streamable_http is accepted (see the create request).

Available options:

streamable_http

allowed_tools

string[]

pii_inspection

boolean

auth

object

Upstream auth for an MCP server. A secret reference is the only supported path: every header value must contain a {{secret_id:<uuid>}} (or legacy {{secret:<name>}}) placeholder. A literal is refused with 422 plaintext_auth — it would sit in cleartext in the control plane.

Show child attributes

status

enum<string>

Use DELETE to archive.

Available options:

active,

paused

pii_redact_policy_id

string<uuid> | null

A PII policy THIS tenant owns (AIGW-151). A policy id you do not own is refused 422 — the FK is id-only, so the ownership check is the control.

firewall_policy_id

string<uuid> | null

guardrail_webhook_url

string<uri> | null

https only; no embedded credentials; SSRF-checked at write time.

guardrail_webhook_secret_id

string<uuid> | null

guardrail_webhook_mode

enum<string>

Available options:

off,

request,

response,

both

guardrail_webhook_timeout_ms

integer

Required range: 100 <= x <= 10000

guardrail_webhook_failure_action

enum<string>

Available options:

fail_open,

fail_closed

Response

The updated MCP server.

data

object

An MCP server KnoxCall proxies and governs. connect_url and resource are deliberately different values — see their descriptions.

Show child attributes

meta

object

Metadata included with every API response.

Show child attributes

Update an MCP server

curl --request PATCH \
  --url https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowed_tools": [
    "get_weather"
  ],
  "status": "paused"
}
'

import requests

url = "https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id}"

payload = {
    "allowed_tools": ["get_weather"],
    "status": "paused"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({allowed_tools: ['get_weather'], status: 'paused'})
};

fetch('https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{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.knoxcall.com/v1/ai-gateway/mcp-servers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowed_tools' => [
        'get_weather'
    ],
    'status' => 'paused'
  ]),
  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.knoxcall.com/v1/ai-gateway/mcp-servers/{id}"

	payload := strings.NewReader("{\n  \"allowed_tools\": [\n    \"get_weather\"\n  ],\n  \"status\": \"paused\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowed_tools\": [\n    \"get_weather\"\n  ],\n  \"status\": \"paused\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.knoxcall.com/v1/ai-gateway/mcp-servers/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowed_tools\": [\n    \"get_weather\"\n  ],\n  \"status\": \"paused\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "gateway_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "server_type": "upstream",
    "transport": "streamable_http",
    "upstream_url": "<string>",
    "allowed_tools": [
      "<string>"
    ],
    "pii_inspection": true,
    "pii_redact_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firewall_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "guardrail_webhook_url": "<string>",
    "guardrail_webhook_secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "guardrail_webhook_mode": "off",
    "guardrail_webhook_timeout_ms": 5050,
    "guardrail_webhook_failure_action": "fail_open",
    "auth": {},
    "sandbox": true,
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "connect_url": "<string>",
    "resource": "<string>"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Overview

Routes

Secrets

Clients

Environments

API Keys

Webhooks

Ephemeral Proxy

AI Gateway

Audit Logs

Account

Tenant KMS

Secret Store Migrations

Changelog

Authorizations

Path Parameters

Body

Response