Retrieves an Interface by its graph object id: a network interface on a Windows, macOS, or Linux endpoint, with its status, IP addresses, and traffic and error counters. An Endpoint lists its current interfaces through interfaces and their history through interfacesSeen; a wireless interface also has a WlanInterface. Find them across endpoints with graphSearch on the INTERFACE 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 an InterfacePayload!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The Interface identifier. |
mockOptions - MockDataInput
|
Options for mock data generation. Options supported: key: "PLATFORM", value: OsPlatform example: "mockOptions": { "options": [ { "key": "PLATFORM", "value": "WINDOWS" } ] } |
Example
Query
query interface(
$id: ID!,
$mockOptions: MockDataInput
) {
interface(
id: $id,
mockOptions: $mockOptions
) {
node {
id
orgId
seen {
...SeenOnlineFragment
}
objectType
objectTypeLabel
displayName
firstSeen
lastSeen
createdAt
updatedAt
snapshotInfo {
...GraphObjectSnapshotInfoFragment
}
endpoint {
...EndpointFragment
}
interfaceId
index
mtu
name
description
type
typeSnmpCode
adminStatus
operationalStatus
isUp
mediaConnectedState
isLoopback
isPointToPoint
supportsBroadcast
supportsMulticast
mac
networks {
...IpPrefixFragment
}
ipNetwork {
...IpNetworkFragment
}
lastStateChange
inPackets
outPackets
packets
inBytes
outBytes
bytes
inErrors
outErrors
errors
inDiscards
outDiscards
collisions
rxRate
txRate
connectedNetworks {
...NetworkConnectionFragment
}
seenConnectedNetworks {
...NetworkConnectionFragment
}
networkPrefixes {
...NetworkPrefixConnectionFragment
}
seenNetworkPrefixes {
...NetworkPrefixConnectionFragment
}
wlanInterfaces {
...WlanInterfaceListFragment
}
findings {
...FindingsPayloadFragment
}
issues {
...IssuesPayloadFragment
}
issuesSummary {
...IssuesSummaryFragment
}
}
}
}
Variables
{
"id": "4",
"mockOptions": MockDataInput
}
Response
{"data": {"interface": {"node": Interface}}}