API Reference
/- tools
agents
agent
agentAudit
topAgentCountByOwner
topAgentCountByEnvironment
topAgentCountByPlatform
topAgentCountByAccessibility
topAgentCountByDataSource
topAgentCountByFindingType
auditTimeline
listEnvironments
listOwners
listPlatforms
listTools
usageRange
lastSessionRange
integrations
integration
listFoundationalModels
tool
dataSources
dataSource
accessChannels
accessChannel
inventoryCategories
listToolTypes
topToolByExternalType
listDataSourceTypes
listChannelTypes
sessionActivities
sessions
sessionsCount
activitiesTimelineChart
detections
detection
flows
flow
policies
policy
testPolicy
policyTriggerTypes
policyActionTypes
policyFilterOptions
previewPolicyImpact
generatePolicyMetadata
users
exportUsers
organizationConfiguration
tools
Download GraphQL schema
Return type
Usagemin
Int!,non-null
max
Int!,non-null
Query sample
query usageRange {
usageRange {
min
max
}
}Response sample
{ "data": { "min": 40, "max": 40 } }
Return type
DateQuery sample
query lastSessionRange {
lastSessionRange {
min
max
}
}Response sample
{ "data": { "min": "Example Custom Scalar", "max": "Example Custom Scalar" } }
Return type
Integrationstenant Id
String!,non-null
items
Query sample
query integrations {
integrations {
tenantId
items {
__typename
# ...IntegrationFragment
}
}
}Response sample
{ "data": { "tenantId": "Example String", "items": [ { "__typename": "Integration" } ] } }
Arguments
platform Type
Return type
Integration!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" } }
Return type
[Foundationalvalue
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 } ] }
Arguments
filter
order By
limit
Int
offset
Int
Return type
Toolsitems
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
I D!,non-nullrequired
Return type
Inventoryid
I D!,non-null
external Id
I D!,non-null
name
String!,non-null
type
String!,non-null
enabled
Boolean!,non-null
environment
created At
updated At
metadata
agent
findings
issues
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" } ] } }
Arguments
filter
order By
limit
Int
offset
Int
Return type
Dataitems
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 } }
Arguments
id
I D!,non-nullrequired
Return type
Inventoryid
I D!,non-null
external Id
I D!,non-null
name
String!,non-null
type
String!,non-null
enabled
Boolean!,non-null
environment
created At
updated At
metadata
agent
findings
issues
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" } ] } }
Arguments
filter
order By
limit
Int
offset
Int
Return type
Accessitems
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 } }
Arguments
id
I D!,non-nullrequired
Return type
Inventoryid
I D!,non-null
external Id
I D!,non-null
name
String!,non-null
type
String!,non-null
enabled
Boolean!,non-null
environment
created At
updated At
metadata
agent
findings
issues
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" } ] } }