---
title: pathSensor query | Wartiva GraphQL API
description: Retrieves a PathSensor configuration: an organization-wide instruction for endpoints to collect file metadata, and optionally checksums, ACLs.
url: https://wartiva.com/api-docs/queries/path-sensor.html
updated: 2026-10-07
---

Organizations and users · GraphQL query

# `pathSensor` query

Retrieves a [PathSensor](https://wartiva.com/api-docs/types/path-sensor.html) configuration: an organization-wide instruction for endpoints to collect file metadata, and optionally checksums, ACLs, or file contents, under one path. Each endpoint that runs the sensor reports into its own [EndpointPath](https://wartiva.com/api-docs/types/endpoint-path.html). Disabled sensors are returned; deleted sensors return a not-found error. Restricted to organization administrators.

## Response

Returns a [`PathSensorPayload!`](https://wartiva.com/api-docs/types/path-sensor-payload.html)

## Arguments

| Name | Description |
|---|---|
| `id` - [`PathSensorId!`](https://wartiva.com/api-docs/types/path-sensor-id.html) | The PathSensor identifier. |

## Example

### Query

```graphql
query pathSensor($id: PathSensorId!) {
  pathSensor(id: $id) {
    node {
      id
      orgId
      name
      description
      path
      inclusions
      exclusions
      recursive
      interval
      collectChecksum
      checksumMaxBytes
      collectContents
      collectAcls
      contentMaxBytes
      isDefault
      enabled
      osTarget {
        ...PathSensorOsTargetFragment
      }
    }
  }
}

```

### Variables

```json
{"id": PathSensorId}

```

### Response

```json
{"data": {"pathSensor": {"node": PathSensor}}}

```

## Related operations

- [`createPathSensor`](https://wartiva.com/api-docs/mutations/create-path-sensor.html) mutation: Creates a new PathSensor for the given organization.
- [`updatePathSensor`](https://wartiva.com/api-docs/mutations/update-path-sensor.html) mutation: Updates an existing user-defined PathSensor.

---

Wartiva is in early access. Request access: https://wartiva.com/early-access.html  
All pages: https://wartiva.com/llms.txt