List virtual keys with their own tool-scan action

GET/v1/virtual-keys/tool-scan-settings

List virtual keys with their own tool-scan action.

The tool-result scan checks the tool results your application sends back to the model (tool-role messages) for injected instructions. A key uses the platform default action unless it sets its own. This answers the default (default_action) and every key of the organization, or of one workspace, that sets its own action; a key not listed uses the default.

Requires a workspace key (member or admin) for workspace_id when it is given, or an organization admin key; an organization-wide list requires an organization admin key. 403 otherwise.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Query parameters

organizationstringrequired
the organization slug
workspace_idstring<uuid>
only keys in this workspace (UUID); omit for the whole organization

Responses

200application/json

default_actionenum<string>
The platform default action, used by every key not listed in data: MONITOR, REDACT or BLOCK.
One of "MONITOR", "REDACT", "BLOCK"
dataobject[]
The keys that set an action of their own. Empty when every key uses the default.
Child attributes
- virtual_key_slugstring
  The virtual key's slug (vk-...).
- actionenum<string>
  The key's own action; absent when the key uses the platform default.
  One of "MONITOR", "REDACT", "BLOCK"
- effective_actionenum<string>
  What the scan does on this key's requests: action, else default_action.
  One of "MONITOR", "REDACT", "BLOCK"
- default_actionenum<string>
  The platform default, used when the key sets no action of its own.
  One of "MONITOR", "REDACT", "BLOCK"

VectorAxis is built by GK Labs, a member of NVIDIA Inception.