---
title: "Get all EVPN session information from across the entire network"
method: GET
path: "/object/evpn"
tags: ["evpn"]
---

# Get all EVPN session information from across the entire network

`GET /object/evpn`

For every Ethernet Virtual Private Network (EVPN) session running on the network, retrieves hostname, VNI status, origin IP address, timestamp, export and import routes, and so forth. Refer to the Evpn model for all data collected.

## Query parameters

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

## Response `200`

successful operation

- Evpn[]
  - `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
  - `hostname` string
  - `opid` integer
  - `vni` integer
  - `origin_ip` string
  - `timestamp` integer
  - `rd` string
  - `export_rt` string
  - `import_rt` string
  - `in_kernel` boolean
  - `adv_all_vni` boolean
  - `adv_gw_ip` string
  - `is_l3` boolean
  - `db_state` string

---

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