Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

FlowGraph

nodes
[FlowStep!]!,non-null
edges
Sample
{ "nodes": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "externalId": "Example String", "name": "Example String", "stepType": "TRIGGER", "platformStepType": "Example String", "configuration": { "__typename": "FlowStepConfiguration" }, "resource": { "__typename": "AgentPreview" }, "findings": [ { "__typename": "Finding" } ], "capturedAt": "Example Custom Scalar" } ], "edges": [ { "source": { "__typename": "FlowStep" }, "target": { "__typename": "FlowStep" }, "condition": "Example Custom Scalar" } ] }
Referenced in

FlowStepEdge

source
FlowStep!,non-null
target
FlowStep!,non-null
condition

Condition expression for conditional branches. Currently JSON, will be more strictly typed in the future.

Sample
{ "source": { "__typename": "FlowStep" }, "target": { "__typename": "FlowStep" }, "condition": "Example Custom Scalar" }
Referenced in

FlowStepConfiguration

raw
inputs
outputs
Sample
{ "raw": "Example Custom Scalar", "inputs": "Example Custom Scalar", "outputs": "Example Custom Scalar" }
Referenced in

FlowStep

id
ID!,non-null
externalId
String
name
String!,non-null
stepType
StepType!,non-null
platformStepType
String
findings
[Finding!]!,non-null
capturedAt
DateTime!,non-null
Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "externalId": "Example String", "name": "Example String", "stepType": "TRIGGER", "platformStepType": "Example String", "configuration": { "__typename": "FlowStepConfiguration" }, "resource": { "__typename": "AgentPreview" }, "findings": [ { "__typename": "Finding" } ], "capturedAt": "Example Custom Scalar" }

FlowPlatformDistribution

platform
Platform!,non-null
count
Int!,non-null
percentage
Float!,non-null
Sample
{ "platform": { "__typename": "Platform" }, "count": 40, "percentage": 40 }

FlowStatusDistribution

status
FlowStatus!,non-null
count
Int!,non-null
percentage
Float!,non-null
Sample
{ "status": "ACTIVE", "count": 40, "percentage": 40 }

FlowEnvironmentDistribution

environment
Environment!,non-null
count
Int!,non-null
percentage
Float!,non-null
Sample
{ "environment": { "__typename": "Environment" }, "count": 40, "percentage": 40 }

FlowOwnerDistribution

owner
Owner!,non-null
count
Int!,non-null
percentage
Float!,non-null
Sample
{ "owner": { "__typename": "Owner" }, "count": 40, "percentage": 40 }

FlowSeverityDistribution

severity
count
Int!,non-null
percentage
Float!,non-null
Sample
{ "severity": "LOW", "count": 40, "percentage": 40 }

FlowAggregations

byPlatform
byEnvironment
bySeverity
withExternalTriggers
Int!,non-null
withAgents
Int!,non-null
Sample
{ "byPlatform": [ { "__typename": "FlowPlatformDistribution" } ], "byStatus": [ { "__typename": "FlowStatusDistribution" } ], "byEnvironment": [ { "__typename": "FlowEnvironmentDistribution" } ], "byOwner": [ { "__typename": "FlowOwnerDistribution" } ], "bySeverity": [ { "__typename": "FlowSeverityDistribution" } ], "withExternalTriggers": 40, "withAgents": 40 }

FlowEdge

node
Flow!,non-null
cursor
String!,non-null
Sample
{ "node": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "description": "Example String", "platform": { "__typename": "Platform" }, "environment": { "__typename": "Environment" }, "owner": { "__typename": "Owner" }, "status": "ACTIVE", "mode": "SYNC", "version": "Example String", "graph": { "__typename": "FlowGraph" }, "agents": [ { "__typename": "AgentPreview" } ], "tools": [ { "__typename": "ToolPreview" } ], "dataSources": [ { "__typename": "DataSourcePreview" } ], "findings": [ { "__typename": "Finding" } ], "issues": [ { "__typename": "Issue" } ], "createdAt": "Example Custom Scalar", "updatedAt": "Example Custom Scalar", "capturedAt": "Example Custom Scalar", "platformCreatedAt": "Example Custom Scalar", "platformUpdatedAt": "Example Custom Scalar", "metadata": "Example Custom Scalar" }, "cursor": "Example String" }
Referenced in

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview