Networks, devices, and sensors · GraphQL query

sensorScopes query

Lists an organization's SensorScope rules, including disabled ones. Each scope controls which Sensor probes may run against which devices, filtered by IP address class, physical location, network, and the number of endpoints seen on a network. A sensor may run when any enabled scope allows it and the device's IP address passes every enabled filter of that scope; multicast addresses are never probed. Every organization has a default scope. Restricted to organization administrators.

Response

Returns a SensorScopesPayload!

Arguments

Name Description
orgId - OrganizationId! The id of the Organization to retrieve SensorScopes for.

Example

Query

query sensorScopes($orgId: OrganizationId!) {
  sensorScopes(orgId: $orgId) {
    sensorScopes {
      id
      orgId
      enabled
      isDefault
      name
      description
      autoAddNewSensors
      sensors {
        ...SensorFragment
      }
      disabledSensors {
        ...SensorFragment
      }
      filterIpProtocol {
        ...SensorFilterIpProtocolFragment
      }
      filterLocations {
        ...SensorFilterLocationsFragment
      }
      filterNetworks {
        ...SensorFilterNetworksFragment
      }
      filterNumEndpoints {
        ...SensorFilterNumEndpointsFragment
      }
      created
      lastUpdateFromDefault
      lastUpdateByUser
      defaultScopeVersion
    }
  }
}

Variables

{"orgId": "615f3b3b28284380e28a7342"}

Response

{
  "data": {
    "sensorScopes": {"sensorScopes": [SensorScope]}
  }
}