API referansı İngilizce yayımlanır.
Update a tool connection
PATCH
/api/tool-connections/{connectionId}Personal API keyAgent API keyConsole session
Update a tool connection.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
connectionIdstringZorunluThe connection's id.
İstek gövdesi
application/json · zorunlu
agentInstructionsobject | nullİsteğe bağlı
agentInstructions.enabledbooleanZorunlu
agentInstructions.textstringZorunlu
1–2000 charactersagentInstructions.templateobjectİsteğe bağlı
agentInstructions.template.idstringZorunlu
1–160 charactersagentInstructions.template.versionintegerZorunlu
> 0applicationNamestringİsteğe bağlı
1–160 charactersnamestringİsteğe bağlı
1–160 charactersconnectionPurposestringİsteğe bağlı
one of: "tool", "channel"transportstringİsteğe bağlı
one of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"authKindstringİsteğe bağlı
one of: "oauth", "api_key", "none"credentialPolicystringİsteğe bağlı
one of: "shared", "per_user", "per_user_with_fallback", "per_agent"ownershipstringİsteğe bağlı
one of: "platform_shared", "platform_provisioned", "customer", "dcr"statusstringİsteğe bağlı
one of: "draft", "active", "disabled", "archived"connectionKindstringİsteğe bağlı
one of: "managed"configobjectİsteğe bağlı
transportConfigobjectİsteğe bağlı
credentialRefsarray<object>İsteğe bağlı
credentialRefs[].namestringZorunlu
1–120 characterscredentialRefs[].secretIdstring (uuid)Zorunlu
credentialRefs[].versionstring | integerİsteğe bağlı
credentialRefs[].placementstringZorunlu
one of: "header", "env", "url"credentialRefs[].keystringZorunlu
1–160 characterscredentialRefs[].prefixstring | nullİsteğe bağlı
at most 120 characterscredentialSecretRefsarray<object>İsteğe bağlı
credentialSecretRefs[].secretIdstring (uuid)Zorunlu
credentialSecretRefs[].versionSelectorstring | integerİsteğe bağlı
credentialSecretRefs[].configPathstringZorunlu
1–200 characterscredentialSecretRefs[].requiredbooleanİsteğe bağlı
credentialSecretRefs[].labelstring | nullİsteğe bağlı
at most 120 characterscredentialSecretRefs[].projectionClassstringİsteğe bağlı
one of: "unclassified", "class_3_static_lease"credentialSecretRefs[].projectionAllowlistKeystring | nullİsteğe bağlı
1–160 characterscredentialSecretRefs[].keyScopestringİsteğe bağlı
1–160 characterscredentialSecretRefs[].expiresAtstring (date-time)İsteğe bağlı
enabledbooleanİsteğe bağlı
Yanıtlar
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.