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

Test tool policy decision

POST/api/companies/{companyId}/tools/policy/test
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Test tool policy decision.

Авторизация

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

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

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

Тело запроса

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

companyIdstring (uuid)Обязательный
actorobjectОбязательный
actor.actorTypestringОбязательныйone of: "agent", "user", "system", "plugin"
actor.actorIdstringОбязательный1–240 characters
actor.agentIdstring (uuid) | nullНеобязательный
runContextobject | nullНеобязательный
runContext.heartbeatRunIdstring (uuid) | nullНеобязательный
runContext.issueIdstring (uuid) | nullНеобязательный
runContext.projectIdstring (uuid) | nullНеобязательный
runContext.routineIdstring (uuid) | nullНеобязательный
runContext.gatewayIdstring (uuid) | nullНеобязательный
runContext.gatewayPublicIdstring | nullНеобязательный1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
runContext.gatewayTokenIdstring (uuid) | nullНеобязательный
runContext.clientSubjectTypestring | nullНеобязательныйone of: "gateway_client", "heartbeat_run", "board_user", "agent"
runContext.clientSubjectIdstring | nullНеобязательный1–240 characters
runContext.clientNamestring | nullНеобязательный1–160 characters
runContext.externalClientboolean | nullНеобязательный
requestobjectОбязательный
request.applicationIdstring (uuid) | nullНеобязательный
request.connectionIdstring (uuid) | nullНеобязательный
request.catalogEntryIdstring (uuid) | nullНеобязательный
request.toolNamestringОбязательный1–240 characters
request.argumentsanyНеобязательный
request.idempotencyKeystring | nullНеобязательный1–512 characters
request.sideEffectingbooleanНеобязательный
consumeRateLimitbooleanНеобязательный
writeAuditEventbooleanНеобязательный

Ответы

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