Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

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

FlowConnection

nodes
[Flow!]!,non-null
edges
[FlowEdge!]!,non-null
pageInfo
PageInfo!,non-null
totalCount
Int!,non-null
aggregations
Sample
{ "nodes": [ { "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" } ], "edges": [ { "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" } ], "pageInfo": { "hasNextPage": true, "hasPreviousPage": true, "startCursor": "Example String", "endCursor": "Example String" }, "totalCount": 40, "aggregations": { "__typename": "FlowAggregations" } }

FlowStatusFilterOutput

in
[FlowStatus!],non-null
Sample
{ "in": [ "ACTIVE" ] }

FlowModeFilterOutput

in
[FlowMode!],non-null
Sample
{ "in": [ "SYNC" ] }
Referenced in

FlowAgentFilterOutput

Sample
{ "id": { "__typename": "StringFilterOutput" }, "name": { "__typename": "StringFilterOutput" } }

FlowFilterOutput

search
String
hasExternalTrigger
Sample
{ "id": { "__typename": "StringFilterOutput" }, "search": "Example String", "status": { "__typename": "FlowStatusFilterOutput" }, "platform": { "__typename": "PlatformFilterOutput" }, "environment": { "__typename": "EnvironmentFilterOutput" }, "owner": { "__typename": "OwnerFilterOutput" }, "mode": { "__typename": "FlowModeFilterOutput" }, "hasExternalTrigger": { "__typename": "BooleanFilterOutput" }, "severity": { "__typename": "SeverityFilterOutput" }, "findings": { "__typename": "FindingFilterOutput" }, "agents": { "__typename": "FlowAgentFilterOutput" }, "createdAt": { "__typename": "DateTimeFilterOutput" }, "updatedAt": { "__typename": "DateTimeFilterOutput" } }

Tool

externalId
ID!,non-null
id
ID!,non-null
type
String!,non-null
name
String
enabled
Boolean!,non-null
issues
[Issue!],non-null
findings
[Finding!],non-null

Implements interfaces

Sample
{ "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "type": "Example String", "name": "Example String", "enabled": true, "issues": [ { "__typename": "Issue" } ], "findings": [ { "__typename": "Finding" } ] }
Referenced in

DataSource

externalId
ID!,non-null
id
ID!,non-null
name
String
enabled
Boolean!,non-null
issues
[Issue!],non-null
type
String!,non-null
findings
[Finding!],non-null

Implements interfaces

Sample
{ "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "enabled": true, "issues": [ { "__typename": "Issue" } ], "type": "Example String", "findings": [ { "__typename": "Finding" } ] }

AccessChannel

externalId
ID!,non-null
id
ID!,non-null
name
String
enabled
Boolean!,non-null
issues
[Issue!],non-null
findings
[Finding!],non-null

Implements interfaces

Sample
{ "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "enabled": true, "issues": [ { "__typename": "Issue" } ], "findings": [ { "__typename": "Finding" } ] }

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview