Справочник API публикуется на английском языке.

Update a tool connection

PATCH/api/tool-connections/{connectionId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Update a tool connection.

Авторизация

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. Как работают ключи.

Параметры пути

connectionIdstringОбязательныйThe connection's id.

Тело запроса

application/json · обязательно

agentInstructionsobject | nullНеобязательный
agentInstructions.enabledbooleanОбязательный
agentInstructions.textstringОбязательный1–2000 characters
agentInstructions.templateobjectНеобязательный
agentInstructions.template.idstringОбязательный1–160 characters
agentInstructions.template.versionintegerОбязательный> 0
applicationNamestringНеобязательный1–160 characters
namestringНеобязательный1–160 characters
connectionPurposestringНеобязательныйone of: "tool", "channel"
transportstringНеобязательныйone of: "mcp_remote", "rest_api", "local_stdio", "chat_sdk", "voice"
authKindstringНеобязательныйone of: "oauth", "api_key", "none"
credentialPolicystringНеобязательныйone of: "shared", "per_user", "per_user_with_fallback", "per_agent"
ownershipstringНеобязательныйone of: "platform_shared", "platform_provisioned", "customer", "dcr"
statusstringНеобязательныйone of: "draft", "active", "disabled", "archived"
connectionKindstringНеобязательныйone of: "managed"
configobjectНеобязательный
transportConfigobjectНеобязательный
credentialRefsarray<object>Необязательный
credentialRefs[].namestringОбязательный1–120 characters
credentialRefs[].secretIdstring (uuid)Обязательный
credentialRefs[].versionstring | integerНеобязательный
credentialRefs[].placementstringОбязательныйone of: "header", "env", "url"
credentialRefs[].keystringОбязательный1–160 characters
credentialRefs[].prefixstring | nullНеобязательныйat most 120 characters
credentialSecretRefsarray<object>Необязательный
credentialSecretRefs[].secretIdstring (uuid)Обязательный
credentialSecretRefs[].versionSelectorstring | integerНеобязательный
credentialSecretRefs[].configPathstringОбязательный1–200 characters
credentialSecretRefs[].requiredbooleanНеобязательный
credentialSecretRefs[].labelstring | nullНеобязательныйat most 120 characters
credentialSecretRefs[].projectionClassstringНеобязательныйone of: "unclassified", "class_3_static_lease"
credentialSecretRefs[].projectionAllowlistKeystring | nullНеобязательный1–160 characters
credentialSecretRefs[].keyScopestringНеобязательный1–160 characters
credentialSecretRefs[].expiresAtstring (date-time)Необязательный
enabledbooleanНеобязательный

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Connectors