---
title: SensorScope type | Wartiva GraphQL API
description: An organization's rule for which Sensor probes may run against which devices. Wartiva GraphQL API reference with arguments, fields, and examples.
url: https://wartiva.com/api-docs/types/sensor-scope.html
updated: 2026-10-07
---

Networks, devices, and sensors · GraphQL type

# `SensorScope` type

An organization's rule for which [Sensor](https://wartiva.com/api-docs/types/sensor.html) probes may run against which devices. A scope lists the sensors it enables and up to four filters (IP protocol and address class, location, networks, and number of endpoints on a network). A device IP passes a scope only when every enabled filter allows it; multicast addresses never pass. The sensors allowed on a device are the union across all enabled scopes. Each organization has a vendor-maintained default scope, created automatically, whose sensor list follows the vendor defaults and which can only be enabled or disabled. List an organization's scopes, including disabled ones, with [sensorScopes](https://wartiva.com/api-docs/queries/sensor-scopes.html).

## Fields

| Field Name | Description |
|---|---|
| `id` - [`ID!`](https://wartiva.com/api-docs/types/id.html) | The unique identifier for this SensorScope. |
| `orgId` - [`OrganizationId!`](https://wartiva.com/api-docs/types/organization-id.html) | The id of the Organization this scope belongs to. |
| `enabled` - [`Boolean!`](https://wartiva.com/api-docs/types/boolean.html) | If disabled this scope will not be applied to any Networks or Devices. |
| `isDefault` - [`Boolean!`](https://wartiva.com/api-docs/types/boolean.html) | If true this is the vendor default scope and modifications except enabling or disabling are not allowed. |
| `name` - [`String!`](https://wartiva.com/api-docs/types/string.html) | The name for this scope. |
| `description` - [`String!`](https://wartiva.com/api-docs/types/string.html) | Describes the purpose of this scope. |
| `autoAddNewSensors` - [`Boolean`](https://wartiva.com/api-docs/types/boolean.html) | If true then new sensors released by the vendor will be automatically enabled by this scope. When false, they are added to disabledSensors instead. |
| `sensors` - [`[Sensor!]`](https://wartiva.com/api-docs/types/sensor.html) | The Sensors enabled in this scope. |
| `disabledSensors` - [`[Sensor!]`](https://wartiva.com/api-docs/types/sensor.html) | The Sensors disabled in this scope. A sensor listed here is not re-enabled when the vendor defaults change. |
| `filterIpProtocol` - [`SensorFilterIpProtocol!`](https://wartiva.com/api-docs/types/sensor-filter-ip-protocol.html) | A filter considering IP protocol when determining if any sensors enabled by this scope apply to a Device or Network. |
| `filterLocations` - [`SensorFilterLocations!`](https://wartiva.com/api-docs/types/sensor-filter-locations.html) | A filter considering the geographic location when determining if any sensors enabled by this scope apply to a Device or Network. |
| `filterNetworks` - [`SensorFilterNetworks!`](https://wartiva.com/api-docs/types/sensor-filter-networks.html) | A filter applying this scope to defined Networks. |
| `filterNumEndpoints` - [`SensorFilterNumEndpoints!`](https://wartiva.com/api-docs/types/sensor-filter-num-endpoints.html) | A filter applying this scope only to Networks that have a certain number of endpoints connected. |
| `created` - [`Time!`](https://wartiva.com/api-docs/types/time.html) | The time this scope was first created. |
| `lastUpdateFromDefault` - [`Time`](https://wartiva.com/api-docs/types/time.html) | The time this scope was last updated from the vendor default if applicable. |
| `lastUpdateByUser` - [`Time`](https://wartiva.com/api-docs/types/time.html) | The time this scope was last updated by a user. |
| `defaultScopeVersion` - [`Int`](https://wartiva.com/api-docs/types/int.html) | The version of the vendor default scope last updated from. |

## Used by

- [`SensorScopesPayload`](https://wartiva.com/api-docs/types/sensor-scopes-payload.html) type: Payload wrapper for a list of SensorScope results.

## Example

### Example

```json
{
  "id": 4,
  "orgId": "615f3b3b28284380e28a7342",
  "enabled": false,
  "isDefault": true,
  "name": "xyz789",
  "description": "abc123",
  "autoAddNewSensors": true,
  "sensors": [Sensor],
  "disabledSensors": [Sensor],
  "filterIpProtocol": SensorFilterIpProtocol,
  "filterLocations": SensorFilterLocations,
  "filterNetworks": SensorFilterNetworks,
  "filterNumEndpoints": SensorFilterNumEndpoints,
  "created": "2021-10-07T18:23:25.829Z",
  "lastUpdateFromDefault": "2021-10-07T18:23:25.829Z",
  "lastUpdateByUser": "2021-10-07T18:23:25.829Z",
  "defaultScopeVersion": 123
}

```

---

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