Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

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" }

PolicyActionInput

Input for defining policy actions

type

Type of action to execute

Parameters for CREATE_ISSUE action (required when type is CREATE_ISSUE)

Sample
{ "type": "CREATE_ISSUE", "createIssueParams": { "__typename": "PolicyCreateIssueActionParamsInput" } }

IntRangeFilter

Filter for integer ranges

min
Int

Minimum value (inclusive)

max
Int

Maximum value (inclusive)

Sample
{ "min": 40, "max": 40 }

PolicyFilter

Filter for policies

search
String

Text search across policy fields

Filter by policy mode

Filter by policy status

Filter by trigger type

issuesCount

Filter by issues count range

lastExecutedAt

Filter by last execution time

isDefault
Boolean

Filter by default policies (true = only default, false = only custom, null/undefined = all)

Filter by finding types configured in policy conditions

detectionType

Filter by detection types configured in policy conditions

Sample
{ "search": "Example String", "mode": { "__typename": "PolicyModeFilter" }, "status": { "__typename": "PolicyStatusFilter" }, "triggerType": { "__typename": "PolicyTriggerTypeFilter" }, "issuesCount": { "__typename": "IntRangeFilter" }, "lastExecutedAt": { "__typename": "DateTimeFilter" }, "isDefault": true, "findingType": { "__typename": "FindingTypeFilter" }, "detectionType": { "__typename": "DetectionTypeFilter" } }

PolicyModeFilter

Filter for policy mode

in
[PolicyMode!],non-null

Modes to include in the results

Sample
{ "in": [ "DRAFT" ] }
Referenced in

PolicyStatusFilter

Filter for policy status

in

Statuses to include in the results

Sample
{ "in": [ "ACTIVE" ] }
Referenced in

Scalars

Overview