Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

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

PolicyImpactPreview

Preview of policy impact before applying changes. Shows matching entities.

matchingEntities

Entities that match the policy conditions

Sample
{ "matchingEntities": [ { "__typename": "MatchingEntityGroup" } ] }

PolicyMetadata

AI-generated policy metadata (title and description)

title
String!,non-null

AI-generated title for the policy (5-8 words)

description
String!,non-null

AI-generated description explaining what this policy does (1-3 sentences)

Sample
{ "title": "Example String", "description": "Example String" }

MatchingEntityGroup

Group of entities matching the policy conditions

count
Int!,non-null

Number of entities matching

eventType

Event type that triggers this

Sample
{ "count": 40, "eventType": "AGENT_CREATED" }

StatusDistribution

Distribution of items by status

mode
PolicyMode!,non-null

Status value

status
PolicyStatus!,non-null

Status value

count
Int!,non-null

Number of policies with this mode

percentage
Float!,non-null

Percentage of policies with this status

Sample
{ "mode": "DRAFT", "status": "ACTIVE", "count": 40, "percentage": 40 }

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview