Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

ToolFilterInput

search
String
Sample
{ "id": { "__typename": "StringFilter" }, "search": "Example String", "type": { "__typename": "StringFilter" }, "enabled": { "__typename": "BooleanFilter" }, "environment": { "__typename": "EnvironmentFilter" }, "findings": { "__typename": "FindingFilter" }, "agent": { "__typename": "AgentFilter" } }

DataSourceFilterInput

search
String
Sample
{ "id": { "__typename": "StringFilter" }, "search": "Example String", "type": { "__typename": "StringFilter" }, "enabled": { "__typename": "BooleanFilter" }, "environment": { "__typename": "EnvironmentFilter" }, "findings": { "__typename": "FindingFilter" } }

AccessChannelFilterInput

search
String
Sample
{ "id": { "__typename": "StringFilter" }, "search": "Example String", "enabled": { "__typename": "BooleanFilter" }, "type": { "__typename": "StringFilter" }, "environment": { "__typename": "EnvironmentFilter" }, "findings": { "__typename": "FindingFilter" } }

ToolOrderByInput

field
direction
Sample
{ "field": "NAME", "direction": "ASC" }

DataSourceOrderByInput

direction
Sample
{ "field": "NAME", "direction": "ASC" }

AccessChannelOrderByInput

direction
Sample
{ "field": "NAME", "direction": "ASC" }

AgentReferenceFilter

Simplified filter for agent references in issue queries

Filter by agent ID(s)

Filter by agent name

Filter by agent's platform

Filter by agent's environment

Sample
{ "id": { "__typename": "StringFilter" }, "name": { "__typename": "StringFilter" }, "platform": { "__typename": "PlatformFilter" }, "environment": { "__typename": "EnvironmentFilter" } }
Referenced in

FindingFilter

Filter for findings

Filter by finding type

Filter by finding ID

Sample
{ "type": { "__typename": "FindingTypeFilter" }, "id": { "__typename": "StringFilter" } }

FindingTypeFilter

Filter for finding types

in

Finding types to include in the results

Operator to apply for matching finding types (IN = match if ANY type is present, AND = match if ALL types are present)

Sample
{ "in": [ "INSTRUCTIONS_NOT_CLEAR" ], "operator": "IN" }

PolicyConditionGroupInput

Input for defining condition groups

agentFilter

Optional filter on agent properties

toolFilter

Optional filter on tool properties (for TOOL_INVOCATION trigger)

findingFilter

Optional filter on findings

detectionFilter

Optional filter on runtime detections

Optional nested condition groups

Sample
{ "agentFilter": { "__typename": "AgentFilter" }, "toolFilter": { "__typename": "ToolFilterInput" }, "findingFilter": { "__typename": "FindingFilter" }, "detectionFilter": { "__typename": "DetectionFilter" }, "groups": [ { "__typename": "PolicyConditionGroupInput" } ] }

PolicyCreateIssueActionParamsInput

Input for CREATE_ISSUE action parameters

issueSeverity

Severity to assign when creating an issue

Sample
{ "issueSeverity": "LOW" }

Scalars

Overview