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 TeamUpdated Version 3 · History

Create a tool trust rule from an action request.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.
actionRequestIdstringRequiredThe actionrequest's id.

Request body

application/json · required

argumentModestringOptionalone of: "exact", "action"
namestringOptional1–160 characters
descriptionstring | nullOptionalat most 4000 characters
priorityintegerOptional≥ 0≤ 10000
approvalThresholdintegerOptional≥ 1≤ 50
selectorsobjectOptional
selectors.actorTypestringOptionalone of: "agent", "user", "system", "plugin"
selectors.agentIdstring (uuid)Optional
selectors.agentIdsarray<string (uuid)>Optional
selectors.projectIdstring (uuid)Optional
selectors.projectIdsarray<string (uuid)>Optional
selectors.routineIdstring (uuid)Optional
selectors.routineIdsarray<string (uuid)>Optional
selectors.issueIdstring (uuid)Optional
selectors.issueIdsarray<string (uuid)>Optional
selectors.gatewayIdstring (uuid)Optional
selectors.gatewayIdsarray<string (uuid)>Optional
selectors.gatewayPublicIdstringOptional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
selectors.gatewayPublicIdsarray<string>Optionaleach at most 120 characters
selectors.gatewayTokenIdstring (uuid)Optional
selectors.gatewayTokenIdsarray<string (uuid)>Optional
selectors.clientSubjectTypestringOptionalone of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientSubjectTypesarray<string>Optionalitems one of: "gateway_client", "heartbeat_run", "board_user", "agent"
selectors.clientNamestringOptional1–160 characters
selectors.clientNamesarray<string>Optionaleach at most 160 characters
selectors.externalClientbooleanOptional
selectors.applicationIdstring (uuid)Optional
selectors.applicationIdsarray<string (uuid)>Optional
selectors.connectionIdstring (uuid)Optional
selectors.connectionIdsarray<string (uuid)>Optional
selectors.catalogEntryIdstring (uuid)Optional
selectors.catalogEntryIdsarray<string (uuid)>Optional
selectors.toolNamestringOptional1–240 characters
selectors.toolNamesarray<string>Optionaleach at most 240 characters
selectors.riskLevelstringOptionalone of: "low", "medium", "high", "critical", "read", "write", "destructive"
selectors.riskLevelsarray<string>Optionalitems one of: "low", "medium", "high", "critical", "read", "write", "destructive"
scopeobjectOptional
scope.includeAgentbooleanOptional
scope.includeProjectbooleanOptional
scope.includeIssuebooleanOptional
scope.includeApplicationbooleanOptional
scope.includeConnectionbooleanOptional
scope.includeCatalogEntrybooleanOptional
scope.includeToolbooleanOptional
argumentFiltersobjectOptional
argumentFilters.allowAnybooleanOptional
argumentFilters.exactHashstring | nullOptionalpattern: ^[a-f0-9]{64}$
argumentFilters.allowedHashesarray<string>Optional
argumentFilters.fieldEqualsobjectOptional
argumentFilters.fieldNotEqualsobjectOptional
argumentFilters.fieldInobject<string, array<any>>Optional
argumentFilters.fieldMatchesobject<string, string>Optional
argumentFilters.fieldExistsarray<string>Optionaleach at most 120 characters
argumentFilters.fieldAbsentarray<string>Optionaleach at most 120 characters
expiresAtstring (date-time) | nullOptional
batchApprovalobject | nullOptional
batchApproval.enabledbooleanOptional
batchApproval.maxBatchSizeintegerOptional> 0≤ 100
batchApproval.windowSecondsintegerOptional> 0≤ 31536000

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Connectors