Networks, devices, and sensors · GraphQL query

route query

Retrieves a Route by its graph object id: one entry in a Windows, macOS, or Linux endpoint's IP routing table. An Endpoint lists its current routes through routes and their history through routesSeen; find them across endpoints with graphSearch on the ROUTE 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 RoutePayload!

Arguments

Name Description
id - ID! The Route identifier.
mockOptions - MockDataInput

Options for mock data generation. Options supported: key: "PLATFORM", value: OsPlatform

example: "mockOptions": { "options": [ { "key": "PLATFORM", "value": "WINDOWS" } ] }

Example

Query

query route(
  $id: ID!,
  $mockOptions: MockDataInput
) {
  route(
    id: $id,
    mockOptions: $mockOptions
  ) {
    node {
      id
      orgId
      seen {
        ...SeenOnlineFragment
      }
      objectType
      objectTypeLabel
      displayName
      firstSeen
      lastSeen
      createdAt
      updatedAt
      snapshotInfo {
        ...GraphObjectSnapshotInfoFragment
      }
      endpoint {
        ...EndpointFragment
      }
      destination {
        ...IpNetworkFragment
      }
      nextHop {
        ...IpAddressFragment
      }
      protocol
      metric
      interfaceId
      findings {
        ...FindingsPayloadFragment
      }
      issues {
        ...IssuesPayloadFragment
      }
      issuesSummary {
        ...IssuesSummaryFragment
      }
    }
  }
}

Variables

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

Response

{"data": {"route": {"node": Route}}}