Networks, devices, and sensors · GraphQL query

network query

Retrieves a Network by its graph object id: an IP subnet that managed endpoints have joined, classified as PREMISE, REMOTE, or LINK_LOCAL, with remote networks told apart by their gateway's MAC address. A network links to the endpoints and Device objects seen on it, its gateway devices, its NetworkPrefix addresses, open ports, services, and observed position. An Endpoint lists its networks through networks; find them across the organization with graphSearch on the NETWORK object type. Returns a not-found error when no object has the id, and an error when the id belongs to another object type.

Response

Returns a NetworkPayload!

Arguments

Name Description
id - ID! The Network identifier.
mockOptions - MockDataInput Options for mock data generation. Options supported: none.

Example

Query

query network(
  $id: ID!,
  $mockOptions: MockDataInput
) {
  network(
    id: $id,
    mockOptions: $mockOptions
  ) {
    node {
      id
      orgId
      seen {
        ...SeenOnlineFragment
      }
      objectType
      objectTypeLabel
      displayName
      firstSeen
      lastSeen
      createdAt
      updatedAt
      snapshotInfo {
        ...GraphObjectSnapshotInfoFragment
      }
      networkType
      addressFamily
      ipNet {
        ...IpNetworkFragment
      }
      position {
        ...PositionSeenFragment
      }
      connectedInterfaces {
        ...InterfaceConnectionFragment
      }
      devices {
        ...DeviceConnectionFragment
      }
      endpoints {
        ...EndpointConnectionFragment
      }
      gatewayDevices {
        ...DeviceConnectionFragment
      }
      ports {
        ...OpenPortConnectionFragment
      }
      prefixes {
        ...NetworkPrefixConnectionFragment
      }
      seenConnectedInterfaces {
        ...InterfaceConnectionFragment
      }
      services {
        ...ServiceConnectionFragment
      }
      wlanAccessPoints {
        ...WlanAccessPointConnectionFragment
      }
      wlanInterfaceConnections {
        ...WlanInterfaceConnectionConnectionFragment
      }
      wlanInterfaceConnectionsSeen {
        ...WlanInterfaceConnectionConnectionFragment
      }
      findings {
        ...FindingsPayloadFragment
      }
      issues {
        ...IssuesPayloadFragment
      }
      issuesSummary {
        ...IssuesSummaryFragment
      }
    }
  }
}

Variables

{
  "id": "4",
  "mockOptions": MockDataInput
}

Response

{"data": {"network": {"node": Network}}}