---
title: "Get software interface information for all network devices"
method: GET
path: "/object/interface"
tags: ["interface"]
---

# Get software interface information for all network devices

`GET /object/interface`

Retrieves information about all software interfaces, including type and name of the interfaces, the hostnames of the device where they reside, state, VRF, and so forth. Refer to the Interface model for all data collected.

## Query parameters

- `eq_timestamp` integer
- `count` integer
- `offset` integer

## Response `200`

successful operation

- Interface[]
  - `schema` Schema, required
    - `props` object, required
    - `type` 'RECORD' | 'ENUM' | 'ARRAY' | 'MAP' | 'UNION' | 'FIXED' | 'STRING' | 'BYTES' | 'INT' | 'LONG' | 'FLOAT' | 'DOUBLE' | 'BOOLEAN' | 'NULL', required
    - `logicalType` LogicalType, required
      - `name` string, required
    - `hashCode` integer, required
    - `elementType` Schema, required — recursive
    - `aliases` string[], required
    - `namespace` string, required
    - `fields` Field[], required
      - `props` object, required
      - `name` string, required
      - `schema` Schema, required — recursive
      - `doc` string, required
      - `defaultValue` JsonNode, required
        - `elements` IteratorJsonNode, required
        - `fieldNames` IteratorString, required
        - `binary` boolean, required
        - `intValue` integer, required
        - `object` boolean, required
        - `int` boolean, required
        - `long` boolean, required
        - `double` boolean, required
        - `bigDecimal` boolean, required
        - `bigInteger` boolean, required
        - `textual` boolean, required
        - `boolean` boolean, required
        - `valueNode` boolean, required
        - `containerNode` boolean, required
        - `missingNode` boolean, required
        - `pojo` boolean, required
        - `number` boolean, required
        - `integralNumber` boolean, required
        - `floatingPointNumber` boolean, required
        - `numberValue` Number, required
        - `numberType` 'INT' | 'LONG' | 'BIG_INTEGER' | 'FLOAT' | 'DOUBLE' | 'BIG_DECIMAL', required
        - `longValue` integer, required
        - `bigIntegerValue` integer, required
        - `doubleValue` number, double, required
        - `decimalValue` number, required
        - `booleanValue` boolean, required
        - `binaryValue` string[], required
        - `valueAsInt` integer, required
        - `valueAsLong` integer, required
        - `valueAsDouble` number, double, required
        - `valueAsBoolean` boolean, required
        - `textValue` string, required
        - `valueAsText` string, required
        - `array` boolean, required
        - `fields` IteratorEntryStringJsonNode, required
        - `null` boolean, required
      - `order` 'ASCENDING' | 'DESCENDING' | 'IGNORE', required
      - `aliases` string[], required
      - `jsonProps` object, required
      - `objectProps` object, required
    - `types` Schema[], required
    - `fullName` string, required
    - `enumSymbols` string[], required
    - `doc` string, required
    - `valueType` Schema, required — recursive
    - `fixedSize` integer, required
    - `name` string, required
    - `error` boolean, required
    - `jsonProps` object, required
    - `objectProps` object, required
  - `opid` integer
  - `hostname` string
  - `type` string
  - `timestamp` integer
  - `last_changed` integer
  - `ifname` string
  - `state` string
  - `vrf` string
  - `details` string

---

[API](https://skmtc.net/nvidia/apis/cumulus-netq-2-0-0-api.md) · [All operations](https://skmtc.net/nvidia/apis/cumulus-netq-2-0-0-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/cumulus-netq-2-0-0-api/versions/7f3260b68f45/schema)