Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

FindingTypeFilterOutput

Filter for finding types (output - mirrors FindingTypeFilter input)

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

Policy

Represents a policy that evaluates agent events and creates issues

id
ID!,non-null

Unique identifier for the policy

name
String!,non-null

Policy name

description
String

Detailed description of what the policy does

mode
PolicyMode!,non-null

Current enforcement mode of the policy

status
PolicyStatus!,non-null

Current status of the policy

trigger

Event that triggers policy evaluation

conditions

Conditions that must be met for the policy to match

actions

Actions to execute when policy conditions match

autoResolve
Boolean!,non-null

Automatically resolve issues when conditions are no longer met

isDefault
Boolean!,non-null

Indicates if this policy is a system default or custom/modified by the tenant

issuesCount
Int!,non-null

Number of issues created by this policy

lastExecutedAt

When the policy was last executed

createdAt
DateTime!,non-null

When the policy was created

updatedAt
DateTime!,non-null

When the policy was last updated

createdBy

User who created the policy

updatedBy

User who last updated the policy

version
Int!,non-null

Version number, incremented on each update

deletedAt

When the policy was soft-deleted (null if active)

environmentTypes

Effective environment types where this policy applies. Returns specific environments if conditions include environment filters, or all environments (Prod, Sandbox, Dev) if no environment filter is specified.

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "description": "Example String", "mode": "DRAFT", "status": "ACTIVE", "trigger": { "__typename": "PolicyTrigger" }, "conditions": { "__typename": "PolicyConditionGroup" }, "actions": [ { "__typename": "PolicyAction" } ], "autoResolve": true, "isDefault": true, "issuesCount": 40, "lastExecutedAt": "Example Custom Scalar", "createdAt": "Example Custom Scalar", "updatedAt": "Example Custom Scalar", "createdBy": { "__typename": "Owner" }, "updatedBy": { "__typename": "Owner" }, "version": 40, "deletedAt": "Example Custom Scalar", "environmentTypes": [ "Prod" ] }

PolicyTrigger

Event that triggers policy evaluation

type

Type of trigger event

Sample
{ "type": "AGENT_CREATED" }
Referenced in

PolicyConditionGroup

Group of conditions combined with AND/OR logic. Supports agent properties, findings, and runtime detections.

Filter on agent properties (environment, platform, owner, etc.)

Filter on tool properties (for TOOL_INVOCATION trigger)

findingFilter

Filter on findings present on the agent (type, detectedAt)

detectionFilter

Filter on runtime detections on the agent

Sample
{ "agentFilter": { "__typename": "AgentFilterOutput" }, "toolFilter": { "__typename": "ToolFilterOutput" }, "findingFilter": { "__typename": "FindingFilterOutput" }, "detectionFilter": { "__typename": "DetectionFilterOutput" } }
Referenced in

PolicyAction

Action to execute when policy matches. Policy assigns severity based on context - the same finding can result in different severity issues.

type

Type of action to execute

params

Parameters for the action

Sample
{ "type": "CREATE_ISSUE", "params": { "__typename": "PolicyCreateIssueActionParams" } }
Referenced in

PolicyCreateIssueActionParams

Parameters for CREATE_ISSUE action

issueSeverity

Severity to assign when creating an issue (policy decides severity, not the finding)

Sample
{ "issueSeverity": "LOW" }
Referenced in

IntRange

Integer range output type

min
Int!,non-null

Minimum value

max
Int!,non-null

Maximum value

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

DateTimeRange

DateTime range output type

Minimum datetime value

Maximum datetime value

Sample
{ "min": "Example Custom Scalar", "max": "Example Custom Scalar" }

PolicyFilterOptions

Filter options for policies page including dynamic ranges

issuesCountRange
IntRange!,non-null

Range of issues count across all policies

lastExecutedAtRange

Range of last executed dates across all policies

Sample
{ "issuesCountRange": { "__typename": "IntRange" }, "lastExecutedAtRange": { "__typename": "DateTimeRange" } }

PoliciesResponse

Response type for policies query containing items and total count

items
[Policy!]!,non-null

List of policies matching the filter

total
Int!,non-null

Total count of policies matching the filter (ignoring pagination)

aggregations

Aggregated statistics for the filtered policies (computed lazily via field resolver)

Implements interfaces

Sample
{ "items": [ { "__typename": "Policy" } ], "total": 40, "aggregations": { "__typename": "PolicyAggregations" } }

AgentTestPolicyResult

Result of testing agent-based policy conditions. Shows preview of agents that would be impacted by this policy.

matchingAgents
[Agent!]!,non-null

Agents that match the policy conditions

totalMatches
Int!,non-null

Total number of matching agents

Sample
{ "matchingAgents": [ { "__typename": "Agent" } ], "totalMatches": 40 }
Referenced in

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview