La referencia de la API se publica en inglés.

Create a tool trust rule from an action request

POST/api/companies/{companyId}/tools/action-requests/{actionRequestId}/trust-rule
Personal API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Create a tool trust rule from an action request.

Autorización

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.
actionRequestIdstringObligatorioThe actionrequest's id.

Cuerpo de la solicitud

application/json · obligatorio

argumentModestringOpcionalone of: "exact", "action"
namestringOpcional1–160 characters
descriptionstring | nullOpcionalat most 4000 characters
priorityintegerOpcional≥ 0≤ 10000
approvalThresholdintegerOpcional≥ 1≤ 50
selectorsobjectOpcional
selectors.actorTypestringOpcionalone of: "agent", "user", "system", "plugin"
selectors.agentIdstring (uuid)Opcional
selectors.agentIdsarray<string (uuid)>Opcional
selectors.projectIdstring (uuid)Opcional
selectors.projectIdsarray<string (uuid)>Opcional
selectors.routineIdstring (uuid)Opcional
selectors.routineIdsarray<string (uuid)>Opcional
selectors.issueIdstring (uuid)Opcional
selectors.issueIdsarray<string (uuid)>Opcional
selectors.gatewayIdstring (uuid)Opcional
selectors.gatewayIdsarray<string (uuid)>Opcional
selectors.gatewayPublicIdstringOpcional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
selectors.gatewayPublicIdsarray<string>Opcionaleach at most 120 characters
selectors.gatewayTokenIdstring (uuid)Opcional
selectors.gatewayTokenIdsarray<string (uuid)>Opcional
selectors.clientSubjectTypestringOpcionalone of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientSubjectTypesarray<string>Opcionalitems one of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientNamestringOpcional1–160 characters
selectors.clientNamesarray<string>Opcionaleach at most 160 characters
selectors.externalClientbooleanOpcional
selectors.applicationIdstring (uuid)Opcional
selectors.applicationIdsarray<string (uuid)>Opcional
selectors.connectionIdstring (uuid)Opcional
selectors.connectionIdsarray<string (uuid)>Opcional
selectors.catalogEntryIdstring (uuid)Opcional
selectors.catalogEntryIdsarray<string (uuid)>Opcional
selectors.toolNamestringOpcional1–240 characters
selectors.toolNamesarray<string>Opcionaleach at most 240 characters
selectors.riskLevelstringOpcionalone of: "low", "medium", "high", "critical", "read", "write", "destructive"
selectors.riskLevelsarray<string>Opcionalitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
scopeobjectOpcional
scope.includeAgentbooleanOpcional
scope.includeProjectbooleanOpcional
scope.includeIssuebooleanOpcional
scope.includeApplicationbooleanOpcional
scope.includeConnectionbooleanOpcional
scope.includeCatalogEntrybooleanOpcional
scope.includeToolbooleanOpcional
argumentFiltersobjectOpcional
argumentFilters.allowAnybooleanOpcional
argumentFilters.exactHashstring | nullOpcionalpattern: ^[a-f0-9]{64}$
argumentFilters.allowedHashesarray<string>Opcional
argumentFilters.fieldEqualsobjectOpcional
argumentFilters.fieldNotEqualsobjectOpcional
argumentFilters.fieldInobject<string, array<any>>Opcional
argumentFilters.fieldMatchesobject<string, string>Opcional
argumentFilters.fieldExistsarray<string>Opcionaleach at most 120 characters
argumentFilters.fieldAbsentarray<string>Opcionaleach at most 120 characters
expiresAtstring (date-time) | nullOpcional
batchApprovalobject | nullOpcional
batchApproval.enabledbooleanOpcional
batchApproval.maxBatchSizeintegerOpcional> 0≤ 100
batchApproval.windowSecondsintegerOpcional> 0≤ 31536000

Respuestas

201SuccessCreated; the body holds the new resource.
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.

Connectors