Update a tool connection

PATCH/api/tool-connections/{connectionId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Update a tool connection.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

connectionIdstringRequiredThe connection's id.

Request body

application/json · required

agentInstructionsobject | nullOptional
agentInstructions.enabledbooleanRequired
agentInstructions.textstringRequired1–2000 characters
agentInstructions.templateobjectOptional
agentInstructions.template.idstringRequired1–160 characters
agentInstructions.template.versionintegerRequired> 0
applicationNamestringOptional1–160 characters
namestringOptional1–160 characters
connectionPurposestringOptionalone of: "tool", "channel"
transportstringOptionalone of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"
authKindstringOptionalone of: "oauth", "api_key", "none"
credentialPolicystringOptionalone of: "shared", "per_user", "per_user_with_fallback", "per_agent"
ownershipstringOptionalone of: "platform_shared", "platform_provisioned", "customer", "dcr"
statusstringOptionalone of: "draft", "active", "disabled", "archived"
connectionKindstringOptionalone of: "managed"
configobjectOptional
transportConfigobjectOptional
credentialRefsarray<object>Optional
credentialRefs[].namestringRequired1–120 characters
credentialRefs[].secretIdstring (uuid)Required
credentialRefs[].versionstring | integerOptional
credentialRefs[].placementstringRequiredone of: "header", "env", "url"
credentialRefs[].keystringRequired1–160 characters
credentialRefs[].prefixstring | nullOptionalat most 120 characters
credentialSecretRefsarray<object>Optional
credentialSecretRefs[].secretIdstring (uuid)Required
credentialSecretRefs[].versionSelectorstring | integerOptional
credentialSecretRefs[].configPathstringRequired1–200 characters
credentialSecretRefs[].requiredbooleanOptional
credentialSecretRefs[].labelstring | nullOptionalat most 120 characters
credentialSecretRefs[].projectionClassstringOptionalone of: "unclassified", "class_3_static_lease"
credentialSecretRefs[].projectionAllowlistKeystring | nullOptional1–160 characters
credentialSecretRefs[].keyScopestringOptional1–160 characters
credentialSecretRefs[].expiresAtstring (date-time)Optional
enabledbooleanOptional

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Connectors