Skip to content
/Queries

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

agents

(...args)
AgentsResponse!,non-null

Arguments

filter
AgentFilter
before
DateTime
after
DateTime
orderBy
[AgentOrderByInput!],non-null
limit
Int
Default:100
offset
Int
Default:0

Return type

AgentsResponse!
items
[Agent!]!,non-null
total
Int!,non-null
aggregations
AgentAggregations
metadata
AgentsResponseMetadata
Query sample
query agents(
  $filter: AgentFilter
  $before: DateTime
  $after: DateTime
  $orderBy: [AgentOrderByInput!]
  $limit: Int
  $offset: Int
) {
  agents(
    filter: $filter
    before: $before
    after: $after
    orderBy: $orderBy
    limit: $limit
    offset: $offset
  ) {
    items {
      __typename
      # ...AgentFragment
    }
    total 
    aggregations {
      __typename
      # ...AgentAggregationsFragment
    }
    metadata {
      __typename
      # ...AgentsResponseMetadataFragment
    }
  }
}
Variables
{
  "filter": {
    "search": "Example String",
    "severity": {
      "__typename": "SeverityFilter"
    },
    "platform": {
      "__typename": "PlatformFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "accessibility": {
      "__typename": "AccessibilityFilter"
    },
    "owner": {
      "__typename": "OwnerFilter"
    },
    "tools": {
      "__typename": "ToolFilter"
    },
    "findings": {
      "__typename": "FindingFilter"
    },
    "id": {
      "__typename": "StringFilter"
    },
    "usage": {
      "__typename": "UsageRangeFilter"
    },
    "lastSession": {
      "__typename": "DateRangeFilter"
    },
    "foundationalModel": {
      "__typename": "StringFilter"
    }
  },
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar",
  "orderBy": [
    {
      "field": "NAME",
      "direction": "ASC"
    }
  ],
  "limit": 40,
  "offset": 40
}
Response sample
{
  "data": {
    "items": [
      {
        "__typename": "Agent"
      }
    ],
    "total": 40,
    "aggregations": {
      "__typename": "AgentAggregations"
    },
    "metadata": {
      "__typename": "AgentsResponseMetadata"
    }
  }
}

agent

(id)
Agent

Arguments

id
ID!,non-nullrequired

Return type

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
AgentAccessibility!,non-null
description
String
nodes
[Node!]!,non-null
edges
[Edge!]!,non-null
tools
[Tool!]!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
highestIssueSeverity
Issue
usage
Usage
findings
[Finding!]!,non-null
detections
[DetectionTypeAggregation!],non-null
isRuntimeProtected
Boolean
Query sample
query agent($id: ID!) {
  agent(id: $id) {
    externalId 
    id 
    platform {
      __typename
      # ...PlatformFragment
    }
    name 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    owner {
      __typename
      # ...OwnerFragment
    }
    accessibility 
    description 
    nodes {
      id 
      name 
    }
    edges {
      connectionA 
      connectionB 
      direction 
      type 
    }
    tools {
      __typename
      # ...ToolFragment
    }
    createdAt 
    updatedAt 
    highestIssueSeverity {
      __typename
      # ...IssueFragment
    }
    usage {
      __typename
      # ...UsageFragment
    }
    findings {
      __typename
      # ...FindingFragment
    }
    detections {
      __typename
      # ...DetectionTypeAggregationFragment
    }
    isRuntimeProtected 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "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
  }
}

agentAudit

(...args)
AgentAuditResponse!,non-null

Arguments

agentId
ID!,non-nullrequired
limit
Int
skip
Int
before
DateTime
after
DateTime

Return type

AgentAuditResponse!
items
[AgentAudit!]!,non-null
total
Int!,non-null
Query sample
query agentAudit(
  $agentId: ID!
  $limit: Int
  $skip: Int
  $before: DateTime
  $after: DateTime
) {
  agentAudit(
    agentId: $agentId
    limit: $limit
    skip: $skip
    before: $before
    after: $after
  ) {
    items {
      __typename
      # ...AgentAuditFragment
    }
    total 
  }
}
Variables
{
  "agentId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "limit": 40,
  "skip": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": {
    "items": [
      {
        "__typename": "AgentAudit"
      }
    ],
    "total": 40
  }
}

topAgentCountByOwner

(...args)
[AgentCountByOwner!]!,non-null

Arguments

filter
AgentFilter
limit
Int
before
DateTime
after
DateTime

Return type

[AgentCountByOwner!]!
owner
Owner!,non-null
count
Int!,non-null
Query sample
query topAgentCountByOwner(
  $filter: AgentFilter
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  topAgentCountByOwner(
    filter: $filter
    limit: $limit
    before: $before
    after: $after
  ) {
    owner {
      __typename
      # ...OwnerFragment
    }
    count 
  }
}
Variables
{
  "filter": {
    "search": "Example String",
    "severity": {
      "__typename": "SeverityFilter"
    },
    "platform": {
      "__typename": "PlatformFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "accessibility": {
      "__typename": "AccessibilityFilter"
    },
    "owner": {
      "__typename": "OwnerFilter"
    },
    "tools": {
      "__typename": "ToolFilter"
    },
    "findings": {
      "__typename": "FindingFilter"
    },
    "id": {
      "__typename": "StringFilter"
    },
    "usage": {
      "__typename": "UsageRangeFilter"
    },
    "lastSession": {
      "__typename": "DateRangeFilter"
    },
    "foundationalModel": {
      "__typename": "StringFilter"
    }
  },
  "limit": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": [
    {
      "owner": {
        "__typename": "Owner"
      },
      "count": 40
    }
  ]
}

topAgentCountByEnvironment

(...args)
[AgentCountByEnvironment!]!,non-null

Arguments

filter
AgentFilter
limit
Int
before
DateTime
after
DateTime

Return type

[AgentCountByEnvironment!]!
environment
Environment!,non-null
count
Int!,non-null
Query sample
query topAgentCountByEnvironment(
  $filter: AgentFilter
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  topAgentCountByEnvironment(
    filter: $filter
    limit: $limit
    before: $before
    after: $after
  ) {
    environment {
      __typename
      # ...EnvironmentFragment
    }
    count 
  }
}
Variables
{
  "filter": {
    "search": "Example String",
    "severity": {
      "__typename": "SeverityFilter"
    },
    "platform": {
      "__typename": "PlatformFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "accessibility": {
      "__typename": "AccessibilityFilter"
    },
    "owner": {
      "__typename": "OwnerFilter"
    },
    "tools": {
      "__typename": "ToolFilter"
    },
    "findings": {
      "__typename": "FindingFilter"
    },
    "id": {
      "__typename": "StringFilter"
    },
    "usage": {
      "__typename": "UsageRangeFilter"
    },
    "lastSession": {
      "__typename": "DateRangeFilter"
    },
    "foundationalModel": {
      "__typename": "StringFilter"
    }
  },
  "limit": 40,
  "before": "Example Custom Scalar",
  "after": "Example Custom Scalar"
}
Response sample
{
  "data": [
    {
      "environment": {
        "__typename": "Environment"
      },
      "count": 40
    }
  ]
}

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview