Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

AgentAggregation

Aggregated agent data with preview information Limited to top 5 by count, includes total count across all agents

agentId
ID!,non-null

Agent ID

agentName
String!,non-null

Agent name

platformType
PlatformType!,non-null

Platform type for avatar display

count
Int!,non-null

Count of indicators for this agent

Sample
{ "agentId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "agentName": "Example String", "platformType": "POWERPLATFORM", "count": 40 }
Referenced in

FindingTypeSummary

Summary of finding types in a cluster

Top finding types (up to 5, sorted by count descending)

total
Int!,non-null

Total number of distinct finding types

Sample
{ "items": [ { "__typename": "FindingTypeAggregation" } ], "total": 40 }

AgentSummary

Summary of agents in a cluster

items

Top agents (up to 5, sorted by count descending)

total
Int!,non-null

Total number of distinct agents

Sample
{ "items": [ { "__typename": "AgentAggregation" } ], "total": 40 }

ActivitiesTimelineChartResponse

metadata
totalActivities
Int!,non-null
totalIndicators
Int!,non-null
Sample
{ "metadata": { "__typename": "TimelineQueryMetadata" }, "bins": [ { "__typename": "ActivitiesTimelineBin" } ], "totalActivities": 40, "totalIndicators": 40 }

AgentPreview

id
ID!,non-null
name
String!,non-null
platform
Platform!,non-null

Implements interfaces

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "platform": { "__typename": "Platform" } }

ToolPreview

id
ID!,non-null
name
String!,non-null
type
String!,non-null

Implements interfaces

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "type": "Example String" }

DataSourcePreview

id
ID!,non-null
name
String!,non-null
type
String!,non-null

Implements interfaces

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "type": "Example String" }

AccessChannelPreview

id
ID!,non-null
name
String!,non-null
type
String!,non-null

Implements interfaces

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "type": "Example String" }
Referenced in

Agent

externalId
ID!,non-null
id
ID!,non-null
platform
Platform!,non-null
name
String!,non-null
environment
Environment!,non-null
owner
Owner!,non-null
accessibility
description
String
nodes
[Node!]!,non-null
edges
[Edge!]!,non-null
tools
[Tool!]!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
highestIssueSeverity
usage
findings
[Finding!]!,non-null
detections
isRuntimeProtected
Boolean
Sample
{ "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "platform": { "__typename": "Platform" }, "name": "Example String", "environment": { "__typename": "Environment" }, "owner": { "__typename": "Owner" }, "accessibility": "PUBLIC", "description": "Example String", "nodes": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String" } ], "edges": [ { "connectionA": "Example String", "connectionB": "Example String", "direction": "ATOB", "type": "NORMAL" } ], "tools": [ { "__typename": "Tool" } ], "createdAt": "Example Custom Scalar", "updatedAt": "Example Custom Scalar", "highestIssueSeverity": { "__typename": "Issue" }, "usage": { "__typename": "Usage" }, "findings": [ { "__typename": "Finding" } ], "detections": [ { "__typename": "DetectionTypeAggregation" } ], "isRuntimeProtected": true }

Environment

externalId
ID!,non-null
id
ID!,non-null
name
String!,non-null
Sample
{ "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "envType": "Prod" }

Owner

externalId
ID!,non-null
id
ID!,non-null
name
String
jobTitle
String
email
String
Sample
{ "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "jobTitle": "Example String", "email": "Example String" }

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview