Update a connector

PUT/v1/mcp-integrations/{slug}

Update a connector.

A partial update: absent fields are left unchanged. Changing the URL, the spec or the credentials marks a synced connector STALE until it is synced again. Sending guardrail_slugs replaces the list.

Requires an organization admin key, or a workspace admin key for the owning workspace (an organization-level connector needs an organization admin). Changing org_connection_for_users also requires an organization admin key. Returns 400 for settings that do not fit the connector's kind or auth type. Returns 402 when the organization's plan does not include the MCP Gateway. Returns 404 when the connector does not exist in the organization.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

slugstringrequired
The connector's slug (mcpi-...).

Query parameters

organizationstringrequired
The organization's identifier (slug).

Request body application/json

the fields to change

namestring
New display name, up to 255 characters. A blank value is ignored.
At least 0 characters · At most 255 characters
descriptionstring
New description.
urlstring
New upstream URL (or base URL for a REST connector), up to 2048 characters; it must pass the egress policy.
At least 0 characters · At most 2048 characters
auth_typeenum<string>
New auth type: NONE, HEADERS, OAUTH_AUTO or OAUTH_CLIENT_CREDENTIALS.
One of "NONE", "HEADERS", "OAUTH_AUTO", "OAUTH_CLIENT_CREDENTIALS"
headersmap<string, string>
HEADERS auth: replaces the stored headers. Write-only. Switching back to HEADERS without sending headers keeps the stored set.
oauthobject
OAuth settings for a connector that authenticates upstream with OAuth. OAUTH_CLIENT_CREDENTIALS needs client_id and client_secret: a client you registered at the upstream's authorization server. For OAUTH_AUTO on an MCP server they are optional: without a client the gateway registers itself; give one when the upstream requires pre-registration. On an OPENAPI or HTTP connector, OAuth needs token_endpoint, and OAUTH_AUTO also needs authorization_endpoint and client_id.
Child attributes
- client_idstring
  The OAuth client ID, up to 500 characters.
  At least 0 characters · At most 500 characters
- client_secretstringwrite-only
  The client secret, up to 2000 characters. Write-only: stored encrypted, never returned.
  At least 0 characters · At most 2000 characters
- scopesstring
  Scopes to request, space-separated, up to 1000 characters. Empty clears them.
  At least 0 characters · At most 1000 characters
- token_endpointstring
  The upstream token endpoint, up to 2000 characters. On an MCP server it skips discovery for client credentials. It must pass the egress policy.
  At least 0 characters · At most 2000 characters
- authorization_endpointstring
  OAUTH_AUTO on an OPENAPI or HTTP connector: where people sign in (an https URL, up to 2000 characters). An MCP server's is discovered, so it is refused there.
  At least 0 characters · At most 2000 characters
spec_urlstring
OPENAPI only: a new spec URL. Empty clears it (an uploaded document must then be kept or given).
At least 0 characters · At most 2048 characters
spec_contentstring
OPENAPI only: a new uploaded document, replacing the stored one. Empty clears it.
spec_formatenum<string>
OPENAPI only: the format of spec_content, JSON or YAML. Required with spec_content.
One of "JSON", "YAML"
http_toolsobject[]
HTTP only: replaces the declared endpoints. At most 200.
At most 200 items
Child attributes
- namestringrequired
  The tool's name, up to 128 characters.
  At least 0 characters · At most 128 characters
- methodstringrequired
  The HTTP method: GET, POST, PUT, PATCH, DELETE or HEAD.
  At least 1 characters
- pathstringrequired
  The path, relative to the connector's base URL, up to 2048 characters. May hold {name} placeholders filled from arguments.
  At least 0 characters · At most 2048 characters
- titlestring
  Human-readable title, up to 255 characters.
  At least 0 characters · At most 255 characters
- descriptionstring
  What the tool does, up to 4000 characters. Agents read it to choose the tool.
  At least 0 characters · At most 4000 characters
- querystring[]
  Arguments sent as query parameters.
- headersstring[]
  Arguments sent as request headers.
- input_schemamap<string, object>
  A JSON Schema of type object; its properties are the tool's arguments.
- body_formatstring
  How the body is encoded: json (default) or form.
query_paramsmap<string, string>
Query-parameter credentials (OPENAPI and HTTP, HEADERS auth): replaces the stored set; empty clears it.
global_workspace_accessboolean
Organization-level connectors only: true shares it with every workspace. Setting true on a workspace-owned connector is a 400.
org_connection_for_usersboolean
OAUTH_AUTO only: whether a signed-in person without their own connected account may use the organization connection. Changing it requires an organization admin.
statusenum<string>
ACTIVE or DISABLED. A disabled connector cannot be synced or used by new servers.
One of "ACTIVE", "DISABLED"
guardrail_slugsstring[]
Replaces the connector's guardrails (in order, at most 10); an empty list removes them all.
At most 10 items

Responses

200application/json

idstring<uuid>
The connector's ID (UUID).
slugstring
The connector's slug (mcpi- followed by 16 characters), used in the API paths.
organizationstring
The organization that owns it.
workspace_idstring<uuid>
The owning workspace (UUID). Absent for an organization-level connector.
namestring
Display name.
descriptionstring
Description.
urlstring
The upstream URL (the base URL for a REST connector).
kindenum<string>
MCP, OPENAPI or HTTP.
One of "MCP", "OPENAPI", "HTTP"
spec_urlstring
OPENAPI: where the document is fetched from.
has_spec_documentboolean
OPENAPI and HTTP: whether an uploaded document is stored. The document itself is not returned.
spec_formatenum<string>
OPENAPI: the format of the uploaded document, JSON or YAML.
One of "JSON", "YAML"
spec_hashstring
OPENAPI and HTTP: SHA-256 of the spec the last sync read.
http_toolsobject[]
HTTP: the declared endpoints.
Child attributes
- namestringrequired
  The tool's name, up to 128 characters.
  At least 0 characters · At most 128 characters
- methodstringrequired
  The HTTP method: GET, POST, PUT, PATCH, DELETE or HEAD.
  At least 1 characters
- pathstringrequired
  The path, relative to the connector's base URL, up to 2048 characters. May hold {name} placeholders filled from arguments.
  At least 0 characters · At most 2048 characters
- titlestring
  Human-readable title, up to 255 characters.
  At least 0 characters · At most 255 characters
- descriptionstring
  What the tool does, up to 4000 characters. Agents read it to choose the tool.
  At least 0 characters · At most 4000 characters
- querystring[]
  Arguments sent as query parameters.
- headersstring[]
  Arguments sent as request headers.
- input_schemamap<string, object>
  A JSON Schema of type object; its properties are the tool's arguments.
- body_formatstring
  How the body is encoded: json (default) or form.
query_param_namesstring[]
Names of the query-parameter credentials. Their values are never returned.
transportenum<string>
The upstream transport: HTTP.
One of "HTTP"
auth_typeenum<string>
NONE, HEADERS, OAUTH_AUTO or OAUTH_CLIENT_CREDENTIALS.
One of "NONE", "HEADERS", "OAUTH_AUTO", "OAUTH_CLIENT_CREDENTIALS"
header_namesstring[]
Names of the stored credential headers. Their values are never returned.
oauthobject
A connector's OAuth client registration with its upstream. The client secret is never returned.
Child attributes
- client_idstring
  The OAuth client ID the gateway uses at the upstream.
- registrationstring
  How the client was registered: PRE_REGISTERED (given by you), CIMD (a client ID metadata document) or DCR (dynamic client registration). Absent until the first sign-in or token request.
- has_client_secretboolean
  true when a client secret is stored.
- issuerstring
  The upstream authorization server the registration is bound to.
- scopesstring
  The scopes requested, space-separated.
- authorization_endpointstring
  Where people sign in. Shown for OPENAPI and HTTP connectors only.
- token_endpointstring
  The upstream token endpoint.
global_workspace_accessboolean
Whether every workspace in the organization may use it.
org_connection_for_usersboolean
OAUTH_AUTO: whether a signed-in person without their own connected account may use the organization connection.
statusenum<string>
ACTIVE or DISABLED.
One of "ACTIVE", "DISABLED"
protocol_versionstring
The MCP protocol version the upstream spoke on the last sync.
protocol_eraenum<string>
MODERN or LEGACY, from protocol_version.
One of "MODERN", "LEGACY"
server_namestring
The name the upstream reported on the last sync (a REST connector: the spec's title).
server_versionstring
The version the upstream reported on the last sync.
instructionsstring
Usage instructions the upstream sent for agents, if any.
sync_statusenum<string>
NEVER, OK, FAILED or STALE.
One of "NEVER", "OK", "FAILED", "STALE"
sync_errorstring
Why the last sync failed. Absent unless sync_status is FAILED.
last_synced_atstring<date-time>
When the last successful sync finished (ISO 8601).
last_sync_attempt_atstring<date-time>
When a sync was last attempted (ISO 8601).
created_bystring
The user who created it.
created_atstring<date-time>
When it was created (ISO 8601).
updated_atstring<date-time>
When it was last changed (ISO 8601).
guardrail_slugsstring[]
Guardrails run on every call through this connector, in order. Empty when there are none.

Request

curl -X PUT "https://api.vectoraxis.ai/v1/mcp-integrations/{slug}?organization=string" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "url": "string",
  "auth_type": "NONE",
  "headers": {
    "key": "string"
  },
  "oauth": {
    "client_id": "string",
    "client_secret": "string",
    "scopes": "string",
    "token_endpoint": "string",
    "authorization_endpoint": "string"
  },
  "spec_url": "string",
  "spec_content": "string",
  "spec_format": "JSON",
  "http_tools": [
    {
      "name": "string",
      "method": "string",
      "path": "string"
    }
  ],
  "query_params": {
    "key": "string"
  },
  "global_workspace_access": true,
  "org_connection_for_users": true,
  "status": "ACTIVE",
  "guardrail_slugs": [
    "string"
  ]
}'

VectorAxis is built by GK Labs, a member of NVIDIA Inception.