La referencia de la API se publica en inglés.
Update a tool connection
PATCH
/api/tool-connections/{connectionId}Personal API keyAgent API keyConsole session
Update a tool connection.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
connectionIdstringObligatorioThe connection's id.
Cuerpo de la solicitud
application/json · obligatorio
agentInstructionsobject | nullOpcional
agentInstructions.enabledbooleanObligatorio
agentInstructions.textstringObligatorio
1–2000 charactersagentInstructions.templateobjectOpcional
agentInstructions.template.idstringObligatorio
1–160 charactersagentInstructions.template.versionintegerObligatorio
> 0applicationNamestringOpcional
1–160 charactersnamestringOpcional
1–160 charactersconnectionPurposestringOpcional
one of: "tool", "channel"transportstringOpcional
one of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"authKindstringOpcional
one of: "oauth", "api_key", "none"credentialPolicystringOpcional
one of: "shared", "per_user", "per_user_with_fallback", "per_agent"ownershipstringOpcional
one of: "platform_shared", "platform_provisioned", "customer", "dcr"statusstringOpcional
one of: "draft", "active", "disabled", "archived"connectionKindstringOpcional
one of: "managed"configobjectOpcional
transportConfigobjectOpcional
credentialRefsarray<object>Opcional
credentialRefs[].namestringObligatorio
1–120 characterscredentialRefs[].secretIdstring (uuid)Obligatorio
credentialRefs[].versionstring | integerOpcional
credentialRefs[].placementstringObligatorio
one of: "header", "env", "url"credentialRefs[].keystringObligatorio
1–160 characterscredentialRefs[].prefixstring | nullOpcional
at most 120 characterscredentialSecretRefsarray<object>Opcional
credentialSecretRefs[].secretIdstring (uuid)Obligatorio
credentialSecretRefs[].versionSelectorstring | integerOpcional
credentialSecretRefs[].configPathstringObligatorio
1–200 characterscredentialSecretRefs[].requiredbooleanOpcional
credentialSecretRefs[].labelstring | nullOpcional
at most 120 characterscredentialSecretRefs[].projectionClassstringOpcional
one of: "unclassified", "class_3_static_lease"credentialSecretRefs[].projectionAllowlistKeystring | nullOpcional
1–160 characterscredentialSecretRefs[].keyScopestringOpcional
1–160 characterscredentialSecretRefs[].expiresAtstring (date-time)Opcional
enabledbooleanOpcional
Respuestas
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.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.