Skip to content
API Reference
/
/
integration

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

listPlatforms

[PlatformOption!]!,non-null

Return type

[PlatformOption!]!
type
PlatformType!,non-null
name
String!,non-null
count
Int!,non-null
Query sample
query listPlatforms {
  listPlatforms {
    type 
    name 
    count 
  }
}
Response sample
{
  "data": [
    {
      "type": "POWERPLATFORM",
      "name": "Example String",
      "count": 40
    }
  ]
}

listTools

[ToolOption!]!,non-null

Return type

[ToolOption!]!
id
ID!,non-null
name
String
type
String!,non-null
count
Int!,non-null
Query sample
query listTools {
  listTools {
    id 
    name 
    type 
    count 
  }
}
Response sample
{
  "data": [
    {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "name": "Example String",
      "type": "Example String",
      "count": 40
    }
  ]
}

usageRange

UsageRange!,non-null

Return type

UsageRange!
min
Int!,non-null
max
Int!,non-null
Query sample
query usageRange {
  usageRange {
    min 
    max 
  }
}
Response sample
{
  "data": {
    "min": 40,
    "max": 40
  }
}

lastSessionRange

DateRange!,non-null

Return type

DateRange!
Query sample
query lastSessionRange {
  lastSessionRange {
    min 
    max 
  }
}
Response sample
{
  "data": {
    "min": "Example Custom Scalar",
    "max": "Example Custom Scalar"
  }
}

integrations

IntegrationsResponse!,non-null

Return type

IntegrationsResponse!
tenantId
String!,non-null
items
[Integration!]!,non-null
Query sample
query integrations {
  integrations {
    tenantId 
    items {
      __typename
      # ...IntegrationFragment
    }
  }
}
Response sample
{
  "data": {
    "tenantId": "Example String",
    "items": [
      {
        "__typename": "Integration"
      }
    ]
  }
}

integration

(platformType)
Integration!,non-null

Arguments

platformType
PlatformType!,non-nullrequired

Return type

Integration!
platform
Platform!,non-null
status
IntegrationStatus!,non-null
description
String!,non-null
error
String
Query sample
query integration($platformType: PlatformType!) {
  integration(platformType: $platformType) {
    platform {
      __typename
      # ...PlatformFragment
    }
    status 
    description 
    error 
  }
}
Variables
{
  "platformType": "POWERPLATFORM"
}
Response sample
{
  "data": {
    "platform": {
      "__typename": "Platform"
    },
    "status": "DISABLED",
    "description": "Example String",
    "error": "Example String"
  }
}

listFoundationalModels

[FoundationalModelOption!]!,non-null

Return type

[FoundationalModelOption!]!
value
String!,non-null
label
String!,non-null
count
Int!,non-null
Query sample
query listFoundationalModels {
  listFoundationalModels {
    value 
    label 
    count 
  }
}
Response sample
{
  "data": [
    {
      "value": "Example String",
      "label": "Example String",
      "count": 40
    }
  ]
}

tools

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

Arguments

filter
ToolFilterInput
orderBy
[ToolOrderByInput!],non-null
limit
Int
offset
Int

Return type

ToolsResponse!
items
[InventoryToolListItem!]!,non-null
total
Int!,non-null
Query sample
query tools(
  $filter: ToolFilterInput
  $orderBy: [ToolOrderByInput!]
  $limit: Int
  $offset: Int
) {
  tools(
    filter: $filter
    orderBy: $orderBy
    limit: $limit
    offset: $offset
  ) {
    items {
      __typename
      # ...InventoryToolListItemFragment
    }
    total 
  }
}
Variables
{
  "filter": {
    "id": {
      "__typename": "StringFilter"
    },
    "search": "Example String",
    "type": {
      "__typename": "StringFilter"
    },
    "enabled": {
      "__typename": "BooleanFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "findings": {
      "__typename": "FindingFilter"
    },
    "agent": {
      "__typename": "AgentFilter"
    }
  },
  "orderBy": [
    {
      "field": "NAME",
      "direction": "ASC"
    }
  ],
  "limit": 40,
  "offset": 40
}
Response sample
{
  "data": {
    "items": [
      {
        "__typename": "InventoryToolListItem"
      }
    ],
    "total": 40
  }
}

Arguments

id
ID!,non-nullrequired

Return type

InventoryTool
id
ID!,non-null
externalId
ID!,non-null
name
String!,non-null
type
String!,non-null
enabled
Boolean!,non-null
environment
Environment!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
metadata
JSON
agent
InventoryAgent!,non-null
findings
[Finding!],non-null
issues
[Issue!],non-null
detections
[DetectionTypeAggregation!],non-null
Query sample
query tool($id: ID!) {
  tool(id: $id) {
    id 
    externalId 
    name 
    type 
    enabled 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    createdAt 
    updatedAt 
    metadata 
    agent {
      __typename
      # ...InventoryAgentFragment
    }
    findings {
      __typename
      # ...FindingFragment
    }
    issues {
      __typename
      # ...IssueFragment
    }
    detections {
      __typename
      # ...DetectionTypeAggregationFragment
    }
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "type": "Example String",
    "enabled": true,
    "environment": {
      "__typename": "Environment"
    },
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "metadata": "Example Custom Scalar",
    "agent": {
      "__typename": "InventoryAgent"
    },
    "findings": [
      {
        "__typename": "Finding"
      }
    ],
    "issues": [
      {
        "__typename": "Issue"
      }
    ],
    "detections": [
      {
        "__typename": "DetectionTypeAggregation"
      }
    ]
  }
}

dataSources

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

Arguments

filter
DataSourceFilterInput
orderBy
[DataSourceOrderByInput!],non-null
limit
Int
offset
Int

Return type

DataSourcesResponse!
items
[InventoryDataSourceListItem!]!,non-null
total
Int!,non-null
Query sample
query dataSources(
  $filter: DataSourceFilterInput
  $orderBy: [DataSourceOrderByInput!]
  $limit: Int
  $offset: Int
) {
  dataSources(
    filter: $filter
    orderBy: $orderBy
    limit: $limit
    offset: $offset
  ) {
    items {
      __typename
      # ...InventoryDataSourceListItemFragment
    }
    total 
  }
}
Variables
{
  "filter": {
    "id": {
      "__typename": "StringFilter"
    },
    "search": "Example String",
    "type": {
      "__typename": "StringFilter"
    },
    "enabled": {
      "__typename": "BooleanFilter"
    },
    "environment": {
      "__typename": "EnvironmentFilter"
    },
    "findings": {
      "__typename": "FindingFilter"
    }
  },
  "orderBy": [
    {
      "field": "NAME",
      "direction": "ASC"
    }
  ],
  "limit": 40,
  "offset": 40
}
Response sample
{
  "data": {
    "items": [
      {
        "__typename": "InventoryDataSourceListItem"
      }
    ],
    "total": 40
  }
}

dataSource

(id)
InventoryDataSource

Arguments

id
ID!,non-nullrequired

Return type

InventoryDataSource
id
ID!,non-null
externalId
ID!,non-null
name
String!,non-null
type
String!,non-null
enabled
Boolean!,non-null
environment
Environment!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
metadata
JSON
agent
InventoryAgent!,non-null
findings
[Finding!],non-null
issues
[Issue!],non-null
detections
[DetectionTypeAggregation!],non-null
Query sample
query dataSource($id: ID!) {
  dataSource(id: $id) {
    id 
    externalId 
    name 
    type 
    enabled 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    createdAt 
    updatedAt 
    metadata 
    agent {
      __typename
      # ...InventoryAgentFragment
    }
    findings {
      __typename
      # ...FindingFragment
    }
    issues {
      __typename
      # ...IssueFragment
    }
    detections {
      __typename
      # ...DetectionTypeAggregationFragment
    }
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "type": "Example String",
    "enabled": true,
    "environment": {
      "__typename": "Environment"
    },
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "metadata": "Example Custom Scalar",
    "agent": {
      "__typename": "InventoryAgent"
    },
    "findings": [
      {
        "__typename": "Finding"
      }
    ],
    "issues": [
      {
        "__typename": "Issue"
      }
    ],
    "detections": [
      {
        "__typename": "DetectionTypeAggregation"
      }
    ]
  }
}

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview