Skip to content
API Reference
/
/
InventoryTool

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

Objects

Overview

AccessChannelNode

id
ID!,non-null
name
String!,non-null
enabled
Boolean!,non-null

Implements interfaces

Node
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "enabled": true
}
Referenced in
EvidenceGraphNode

InventoryCategory

name
InventoryCategoryType!,non-null
count
Int!,non-null
Sample
{
  "name": "AGENTS",
  "count": 40
}
Referenced in
InventoryCategoriesResponse.categories

InventoryCategoriesResponse

categories
[InventoryCategory!]!,non-null
Sample
{
  "categories": [
    {
      "__typename": "InventoryCategory"
    }
  ]
}

InventoryAgent

id
ID!,non-null
externalId
ID!,non-null
name
String!,non-null
platform
Platform!,non-null
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "platform": {
    "__typename": "Platform"
  }
}
Referenced in
InventoryItem.agent
InventoryToolListItem.agent
InventoryTool.agent
InventoryDataSourceListItem.agent
InventoryDataSource.agent
InventoryAccessChannelListItem.agent
InventoryAccessChannel.agent

InventoryToolListItem

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
detections
[DetectionTypeAggregation!],non-null

Implements interfaces

InventoryItem
Sample
{
  "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"
    }
  ],
  "detections": [
    {
      "__typename": "DetectionTypeAggregation"
    }
  ]
}
Referenced in
ToolsResponse.items

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

Implements interfaces

InventoryItem
Sample
{
  "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"
    }
  ]
}

InventoryDataSourceListItem

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
detections
[DetectionTypeAggregation!],non-null

Implements interfaces

InventoryItem
Sample
{
  "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"
    }
  ],
  "detections": [
    {
      "__typename": "DetectionTypeAggregation"
    }
  ]
}
Referenced in
DataSourcesResponse.items

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

Implements interfaces

InventoryItem
Sample
{
  "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"
    }
  ]
}

InventoryAccessChannelListItem

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
detections
[DetectionTypeAggregation!],non-null

Implements interfaces

InventoryItem
Sample
{
  "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"
    }
  ],
  "detections": [
    {
      "__typename": "DetectionTypeAggregation"
    }
  ]
}
Referenced in
AccessChannelsResponse.items

InventoryAccessChannel

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

Implements interfaces

InventoryItem
Sample
{
  "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"
    }
  ]
}

ToolsResponse

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

Implements interfaces

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

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview