Networks, devices, and sensors · GraphQL mutation

sensorRequestSubmit mutation

Runs a Sensor against one device IP address, and optionally one port, by creating a SensorRequest. The device, zone, sensor, IP address, protocol, and port are validated first; the IP address must suit the zone. If a request with the same criteria already exists, it is reset and run again instead of being duplicated, and the existing request's settings are kept. Intended for troubleshooting; requests submitted this way bypass the organization's sensorScopes. Restricted to administrators of the device's organization.

Response

Returns a SensorRequestSubmitPayload!

Arguments

Name Description
input - SensorRequestInput! The input defining the sensor request to submit.

Example

Query

mutation sensorRequestSubmit($input: SensorRequestInput!) {
  sensorRequestSubmit(input: $input) {
    sensorRequest {
      id
      device {
        ...DeviceFragment
      }
      sensor {
        ...SensorFragment
      }
      zone
      ip {
        ...IpAddressFragment
      }
      protocol
      port
      args
      created
      state {
        ...SensorRequestStateFragment
      }
      runIds
      runs {
        ...SensorRequestRunFragment
      }
    }
  }
}

Variables

{"input": SensorRequestInput}

Response

{
  "data": {
    "sensorRequestSubmit": {
      "sensorRequest": SensorRequest
    }
  }
}