Organizations and users · GraphQL type

PathSensor type

An organization-wide instruction telling endpoints to collect file metadata under one filesystem path. Every enrolled endpoint whose OS matches osTarget scans path every interval, optionally recursing, filtering with glob patterns, and collecting checksums, ACLs, or file contents. Each sensor yields one EndpointPath graph object per endpoint, whose entries are the discovered files. The system seeds a set of default sensors into each organization; org admins can add their own with createPathSensor, and list them with pathSensors or fetch one with pathSensor.

Fields

Field Name Description
id - PathSensorId! The PathSensor's unique identifier.
orgId - OrganizationId! Unique identifier that corresponds to your deployment of this product or a specific customer account that this PathSensor belongs to.
name - String! Human-readable label for this sensor. Required; at most 256 bytes.
description - String! Describes what this sensor monitors. At most 4096 bytes.
path - String! The absolute filesystem path or directory this sensor monitors, at most 4096 bytes. On Linux and macOS it starts with / and must be normalized (no . or .. segments or repeated separators). On Windows it must be drive-rooted (for example C:\Program Files); UNC and device paths are rejected.
inclusions - [String!]! Optional glob patterns (doublestar syntax, including **); when non-empty, only paths matching an inclusion under the monitored path are recorded. Inclusions and exclusions together are limited to 256 patterns of at most 4096 bytes each.
exclusions - [String!]! Optional glob patterns (doublestar syntax, including **); paths matching an exclusion under the monitored path are skipped. Shares the 256-pattern limit with inclusions.
recursive - Boolean! Whether the sensor walks directories recursively. A recursive sensor cannot collect file contents.
interval - Duration! How often the endpoint runs this sensor. Must be at least the deployment's configured minimum interval.
collectChecksum - Boolean! Whether the endpoint computes a checksum for each matched file.
checksumMaxBytes - Int64! Maximum file size in bytes to checksum when collectChecksum is true. Files larger than this are not checksummed. Must be positive when collectChecksum is true.
collectContents - Boolean! Whether file bytes are uploaded with each result.
collectAcls - Boolean! Whether the endpoint collects ACL and extended-attribute metadata for each matched file.
contentMaxBytes - Int64! Maximum bytes per file upload when collectContents is true. Must be positive when collectContents is true and may not exceed the deployment's configured maximum.
isDefault - Boolean! True if the system seeded this sensor as an organization default. A default sensor keeps receiving updates to the vendor defaults until an org admin edits it; deleting or disabling it persists across those updates.
enabled - Boolean! Whether this sensor is currently active. pathSensors lists only enabled sensors.
osTarget - PathSensorOsTarget! The OS target this sensor applies to (platform plus optional Linux distribution restriction).

Returned by

  • pathSensor query: Retrieves a PathSensor configuration: an organization-wide instruction for endpoints to collect file metadata, and optionally checksums, ACLs, or…
  • createPathSensor mutation: Creates a new PathSensor for the given organization.
  • updatePathSensor mutation: Updates an existing user-defined PathSensor.

Used by

  • EndpointPath type: The single graph object a PathSensor produces on an Endpoint, so an Endpoint has one EndpointPath per sensor that has reported data from it; list…
  • PathSensorPayload type: Payload wrapper for a single PathSensor.
  • PathSensorsPayload type: Payload wrapper for a page of the enabled PathSensors on an Organization.

Example

Example

{
  "id": PathSensorId,
  "orgId": "615f3b3b28284380e28a7342",
  "name": "xyz789",
  "description": "abc123",
  "path": "abc123",
  "inclusions": ["abc123"],
  "exclusions": ["abc123"],
  "recursive": true,
  "interval": "600000000",
  "collectChecksum": false,
  "checksumMaxBytes": "-8589934592",
  "collectContents": true,
  "collectAcls": true,
  "contentMaxBytes": "-8589934592",
  "isDefault": false,
  "enabled": true,
  "osTarget": PathSensorOsTarget
}