Skip to content
API Reference
/
/
Flow

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

Objects

Overview

DetectionTypeAggregation

id
ID!,non-null
type
DetectionType!,non-null
count
Int!,non-null
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "type": "PII_LEAKAGE",
  "count": 40
}
Referenced in
Agent.detections
InventoryItem.detections
InventoryToolListItem.detections
InventoryTool.detections
InventoryDataSourceListItem.detections
InventoryDataSource.detections
InventoryAccessChannelListItem.detections
InventoryAccessChannel.detections

DetectionFilterOutput

type
DetectionTypeFilterOutput
id
StringFilterOutput
Sample
{
  "type": {
    "__typename": "DetectionTypeFilterOutput"
  },
  "id": {
    "__typename": "StringFilterOutput"
  }
}
Referenced in
PolicyConditionGroup.detectionFilter

DetectionTypeFilterOutput

in
[DetectionType!],non-null
operator
FilterOperator
Sample
{
  "in": [
    "PII_LEAKAGE"
  ],
  "operator": "IN"
}
Referenced in
DetectionFilterOutput.type

DetectionsResponse

items
[Detection!]!,non-null
total
Int!,non-null

Implements interfaces

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

FlowPreview

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

Implements interfaces

EntityPreview
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "platform": {
    "__typename": "Platform"
  },
  "status": "ACTIVE"
}
Referenced in
FlowStepResource

Flow

id
ID!,non-null
externalId
ID!,non-null
name
String!,non-null
description
String
platform
Platform!,non-null
environment
Environment!,non-null
owner
Owner
status
FlowStatus!,non-null
mode
FlowMode!,non-null
version
String
graph
FlowGraph!,non-null
agents
[AgentPreview!]!,non-null
tools
[ToolPreview!]!,non-null
dataSources
[DataSourcePreview!]!,non-null
findings
[Finding!]!,non-null
issues
[Issue!]!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
capturedAt
DateTime!,non-null
platformCreatedAt
DateTime
platformUpdatedAt
DateTime
metadata
JSON
Sample
{
  "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"
}
Referenced in
FlowEdge.node
FlowConnection.nodes

FlowGraph

nodes
[FlowStep!]!,non-null
edges
[FlowStepEdge!]!,non-null
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
Flow.graph

FlowStepEdge

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

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
FlowGraph.edges

FlowStepConfiguration

raw
JSON
inputs
JSON
outputs
JSON
Sample
{
  "raw": "Example Custom Scalar",
  "inputs": "Example Custom Scalar",
  "outputs": "Example Custom Scalar"
}
Referenced in
FlowStep.configuration

FlowStep

id
ID!,non-null
externalId
String
name
String!,non-null
stepType
StepType!,non-null
platformStepType
String
configuration
FlowStepConfiguration
resource
FlowStepResource
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"
}
Referenced in
FlowGraph.nodes
FlowStepEdge.source
FlowStepEdge.target

FlowPlatformDistribution

platform
Platform!,non-null
count
Int!,non-null
percentage
Float!,non-null
Sample
{
  "platform": {
    "__typename": "Platform"
  },
  "count": 40,
  "percentage": 40
}
Referenced in
FlowAggregations.byPlatform

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview