Skip to content
API Reference
/
/
Environment

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

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
highestIssueSeverity
Issue
usage
Usage
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",
      "issues": [
        {
          "__typename": "Issue"
        }
      ]
    }
  ],
  "edges": [
    {
      "connectionA": "Example String",
      "connectionB": "Example String",
      "direction": "ATOB"
    }
  ],
  "tools": [
    {
      "__typename": "Tool"
    }
  ],
  "createdAt": "Example Custom Scalar",
  "highestIssueSeverity": {
    "__typename": "Issue"
  },
  "usage": {
    "__typename": "Usage"
  }
}

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"
}
Referenced in
Agent.environment
AgentCountByEnvironment.environment

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"
}
Referenced in
Agent.owner
AgentCountByOwner.owner

Tool

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

Implements interfaces

Node
Sample
{
  "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "type": "Example String",
  "name": "Example String",
  "enabled": true,
  "issues": [
    {
      "__typename": "Issue"
    }
  ]
}
Referenced in
Agent.tools
AgentCountByTool.tool

DataSource

externalId
ID!,non-null
id
ID!,non-null
name
String!,non-null
status
String!,non-null
issues
[Issue!],non-null
type
String!,non-null

Implements interfaces

Node
Sample
{
  "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "status": "Example String",
  "issues": [
    {
      "__typename": "Issue"
    }
  ],
  "type": "Example String"
}
Referenced in
AgentCountByDataSource.dataSource

AccessChannel

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

Implements interfaces

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

ConnectedAgent

externalId
ID!,non-null
id
ID!,non-null
name
String!,non-null
issues
[Issue!],non-null

Implements interfaces

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

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview