---
title: interface query | Wartiva GraphQL API
description: Retrieves an Interface by its graph object id: a network interface on a Windows, macOS, or Linux endpoint, with its status, IP addresses.
url: https://wartiva.com/api-docs/queries/interface.html
updated: 2026-10-07
---

Networks, devices, and sensors · GraphQL query

# `interface` query

Retrieves an [Interface](https://wartiva.com/api-docs/types/interface.html) 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](https://wartiva.com/api-docs/types/endpoint.html) lists its current interfaces through `interfaces` and their history through `interfacesSeen`; a wireless interface also has a [WlanInterface](https://wartiva.com/api-docs/types/wlan-interface.html). Find them across endpoints with [graphSearch](https://wartiva.com/api-docs/queries/graph-search.html) 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!`](https://wartiva.com/api-docs/types/interface-payload.html)

## Arguments

| Name | Description |
|---|---|
| `id` - [`ID!`](https://wartiva.com/api-docs/types/id.html) | The Interface identifier. |
| `mockOptions` - [`MockDataInput`](https://wartiva.com/api-docs/types/mock-data-input.html) | Options for mock data generation. Options supported: key: "PLATFORM", value: OsPlatform example: "mockOptions": { "options": [ { "key": "PLATFORM", "value": "WINDOWS" } ] } |

## Example

### Query

```graphql
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

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

```

### Response

```json
{"data": {"interface": {"node": Interface}}}

```

---

Wartiva is in early access. Request access: https://wartiva.com/early-access.html  
All pages: https://wartiva.com/llms.txt