Update a tool connection
PATCH
/api/tool-connections/{connectionId}Personal API keyAgent API keyConsole session
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.textstringRequired
1–2000 charactersagentInstructions.templateobjectOptional
agentInstructions.template.idstringRequired
1–160 charactersagentInstructions.template.versionintegerRequired
> 0applicationNamestringOptional
1–160 charactersnamestringOptional
1–160 charactersconnectionPurposestringOptional
one of: "tool", "channel"transportstringOptional
one of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"authKindstringOptional
one of: "oauth", "api_key", "none"credentialPolicystringOptional
one of: "shared", "per_user", "per_user_with_fallback", "per_agent"ownershipstringOptional
one of: "platform_shared", "platform_provisioned", "customer", "dcr"statusstringOptional
one of: "draft", "active", "disabled", "archived"connectionKindstringOptional
one of: "managed"configobjectOptional
transportConfigobjectOptional
credentialRefsarray<object>Optional
credentialRefs[].namestringRequired
1–120 characterscredentialRefs[].secretIdstring (uuid)Required
credentialRefs[].versionstring | integerOptional
credentialRefs[].placementstringRequired
one of: "header", "env", "url"credentialRefs[].keystringRequired
1–160 characterscredentialRefs[].prefixstring | nullOptional
at most 120 characterscredentialSecretRefsarray<object>Optional
credentialSecretRefs[].secretIdstring (uuid)Required
credentialSecretRefs[].versionSelectorstring | integerOptional
credentialSecretRefs[].configPathstringRequired
1–200 characterscredentialSecretRefs[].requiredbooleanOptional
credentialSecretRefs[].labelstring | nullOptional
at most 120 characterscredentialSecretRefs[].projectionClassstringOptional
one of: "unclassified", "class_3_static_lease"credentialSecretRefs[].projectionAllowlistKeystring | nullOptional
1–160 characterscredentialSecretRefs[].keyScopestringOptional
1–160 characterscredentialSecretRefs[].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.