Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

listFoundationalModels

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)

Arguments

orderBy
limit
Int
offset
Int

Return type

ToolsResponse!
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
agent
findings
[Finding!],non-null
issues
[Issue!],non-null
detections
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)

Arguments

limit
Int
offset
Int

Return type

DataSourcesResponse!
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)

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
agent
findings
[Finding!],non-null
issues
[Issue!],non-null
detections
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" } ] } }

accessChannels

(...args)

Arguments

limit
Int
offset
Int

Return type

AccessChannelsResponse!
total
Int!,non-null
Query sample
query accessChannels(
  $filter: AccessChannelFilterInput
  $orderBy: [AccessChannelOrderByInput!]
  $limit: Int
  $offset: Int
) {
  accessChannels(
    filter: $filter
    orderBy: $orderBy
    limit: $limit
    offset: $offset
  ) {
    items {
      __typename
      # ...InventoryAccessChannelListItemFragment
    }
    total 
  }
}
Variables
{ "filter": { "id": { "__typename": "StringFilter" }, "search": "Example String", "enabled": { "__typename": "BooleanFilter" }, "type": { "__typename": "StringFilter" }, "environment": { "__typename": "EnvironmentFilter" }, "findings": { "__typename": "FindingFilter" } }, "orderBy": [ { "field": "NAME", "direction": "ASC" } ], "limit": 40, "offset": 40 }
Response sample
{ "data": { "items": [ { "__typename": "InventoryAccessChannelListItem" } ], "total": 40 } }

accessChannel

(id)

Arguments

id
ID!,non-nullrequired

Return type

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
agent
findings
[Finding!],non-null
issues
[Issue!],non-null
detections
Query sample
query accessChannel($id: ID!) {
  accessChannel(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" } ] } }

inventoryCategories

Return type

InventoryCategoriesResponse!
categories
Query sample
query inventoryCategories {
  inventoryCategories {
    categories {
      __typename
      # ...InventoryCategoryFragment
    }
  }
}
Response sample
{ "data": { "categories": [ { "__typename": "InventoryCategory" } ] } }

listToolTypes

[String!]!,non-null

Return type

[String!]!

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query listToolTypes {
  listToolTypes 
}
Response sample
{ "data": [ "Example String" ] }

topToolByExternalType

(...args)

Arguments

limit
Int
before

Return type

[ToolExternalTypeCount!]!
type
String!,non-null
count
Int!,non-null
Query sample
query topToolByExternalType(
  $limit: Int
  $before: DateTime
  $after: DateTime
) {
  topToolByExternalType(
    limit: $limit
    before: $before
    after: $after
  ) {
    type 
    count 
  }
}
Variables
{ "limit": 40, "before": "Example Custom Scalar", "after": "Example Custom Scalar" }
Response sample
{ "data": [ { "type": "Example String", "count": 40 } ] }

listDataSourceTypes

[String!]!,non-null

Return type

[String!]!

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query listDataSourceTypes {
  listDataSourceTypes 
}
Response sample
{ "data": [ "Example String" ] }

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview