---
title: SensorRequest type | Wartiva GraphQL API
description: A standing request to run one Sensor against one Device IP address, optionally on a specific protocol and port, in the SAE or PUBLIC zone.
url: https://wartiva.com/api-docs/types/sensor-request.html
updated: 2026-10-07
---

Networks, devices, and sensors · GraphQL type

# `SensorRequest` type

A standing request to run one [Sensor](https://wartiva.com/api-docs/types/sensor.html) against one [Device](https://wartiva.com/api-docs/types/device.html) IP address, optionally on a specific protocol and port, in the SAE or PUBLIC zone. LAN-zone sensors run on endpoints directly and never create requests. The system creates requests automatically when it sees a device, an open port, or a network service that an enabled [SensorScope](https://wartiva.com/api-docs/types/sensor-scope.html) allows a sensor to probe; org admins can also submit or reset one with [sensorRequestSubmit](https://wartiva.com/api-docs/mutations/sensor-request-submit.html) or [sensorRequestReSubmit](https://wartiva.com/api-docs/mutations/sensor-request-re-submit.html), which bypass scopes. Its id is derived from the sensor, zone, device, IP, protocol, port, and args, so the same target always maps to the same request. Each attempt is recorded as a [SensorRequestRun](https://wartiva.com/api-docs/types/sensor-request-run.html); `state` tracks expiration, completion, and which endpoints completed or were suppressed. Reach requests through `Device.sensorRequests`, `Service.sensorRequests`, or [sensorRequest](https://wartiva.com/api-docs/queries/sensor-request.html).

## Fields

| Field Name | Description |
|---|---|
| `id` - [`ID!`](https://wartiva.com/api-docs/types/id.html) | A string uniquely identifying this SensorRequest. |
| `device` - [`Device!`](https://wartiva.com/api-docs/types/device.html) | The Device this sensor request run is found on. |
| `sensor` - [`Sensor!`](https://wartiva.com/api-docs/types/sensor.html) | The Sensor this request is for. |
| `zone` - [`SensorZone!`](https://wartiva.com/api-docs/types/sensor-zone.html) | The zone this request is for. |
| `ip` - [`IpAddress!`](https://wartiva.com/api-docs/types/ip-address.html) | The target IP address for this request. |
| `protocol` - [`IpProtocol`](https://wartiva.com/api-docs/types/ip-protocol.html) | The IP protocol this request is for. |
| `port` - [`Int`](https://wartiva.com/api-docs/types/int.html) | The IP port this request is for, an unsigned 16-bit integer. |
| `args` - [`SensorRequestArgs`](https://wartiva.com/api-docs/types/sensor-request-args.html) | Optional list of key/value arguments to use for the SensorRequest. |
| `created` - [`Time!`](https://wartiva.com/api-docs/types/time.html) | The time this SensorRequest was created. |
| `state` - [`SensorRequestState!`](https://wartiva.com/api-docs/types/sensor-request-state.html) | The current state of this SensorRequest. |
| `runIds` - [`[ID!]`](https://wartiva.com/api-docs/types/id.html) | List of unique identifiers for recent runs of this SensorRequest. |
| Arguments `count` - [`Int`](https://wartiva.com/api-docs/types/int.html) Maximum number of run IDs to return. |
| `runs` - [`[SensorRequestRun!]`](https://wartiva.com/api-docs/types/sensor-request-run.html) | List of recent runs of this SensorRequest. |
| Arguments `count` - [`Int`](https://wartiva.com/api-docs/types/int.html) Maximum number of runs to return. |

## Returned by

- [`sensorRequest`](https://wartiva.com/api-docs/queries/sensor-request.html) query: Retrieves a SensorRequest: a standing request to run one Sensor against one device IP address, and optionally one port, with its expiration and…

## Used by

- [`Device`](https://wartiva.com/api-docs/types/device.html) type: A physical or virtual device that does not run the Wartiva endpoint application but is visible on the network to a managed Endpoint, such as…
- [`SensorRequestRun`](https://wartiva.com/api-docs/types/sensor-request-run.html) type: The record of one attempt to run a SensorRequest: when it ran, which sensor version ran it, which Endpoint ran it (none for PUBLIC-zone runs, which…
- [`Service`](https://wartiva.com/api-docs/types/service.html) type: A network service identified on a discovered Device: one protocol (such as HTTP, TLS, SSH, SMB, DNS, SNMP, IPP, mDNS, or UPnP) acting as a client or…
- [`SensorRequestPayload`](https://wartiva.com/api-docs/types/sensor-request-payload.html) type: Payload wrapper for a single SensorRequest result.
- [`SensorRequestReRunPayload`](https://wartiva.com/api-docs/types/sensor-request-re-run-payload.html) type: Payload wrapper for a re-run SensorRequest result.
- [`SensorRequestSubmitForServicePayload`](https://wartiva.com/api-docs/types/sensor-request-submit-for-service-payload.html) type: Payload wrapper for sensor requests submitted for a service.
- [`SensorRequestSubmitPayload`](https://wartiva.com/api-docs/types/sensor-request-submit-payload.html) type: Payload wrapper for a submitted SensorRequest result.

## Related types

- [`Device`](https://wartiva.com/api-docs/types/device.html) A physical or virtual device that does not run the Wartiva endpoint application but is visible on the network to a managed Endpoint, such as…
- [`SensorRequestRun`](https://wartiva.com/api-docs/types/sensor-request-run.html) The record of one attempt to run a SensorRequest: when it ran, which sensor version ran it, which Endpoint ran it (none for PUBLIC-zone runs, which…

## Example

### Example

```json
{
  "id": 4,
  "device": Device,
  "sensor": Sensor,
  "zone": "LAN",
  "ip": IpAddress,
  "protocol": "TCP",
  "port": 987,
  "args": SensorRequestArgs,
  "created": "2021-10-07T18:23:25.829Z",
  "state": SensorRequestState,
  "runIds": ["4"],
  "runs": [SensorRequestRun]
}

```

---

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