---
title: "List Network Flow"
method: POST
path: "/network-flow/get-list"
tags: ["Network Flow"]
---

# List Network Flow

`POST /network-flow/get-list`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/network-flow/get-list`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/network-flow/get-list/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to list all Network Flow items

## Request body

- object
  - `query` NetworkFlowV1QuerySchema: Query schema for NetworkFlowV1. A field takes a plain value, which it matches exactly, or an operator its type allows. Telemetry tables are large: bound every query by flowStartAt.
    - `projectId` union: Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `networkDeviceId` union: Query operators for networkDeviceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `exporterIp` union: Query operators for exporterIp field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `srcIp` union: Query operators for srcIp field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `dstIp` union: Query operators for dstIp field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `srcPort` union: Query operators for srcPort field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `dstPort` union: Query operators for dstPort field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `protocol` union: Query operators for protocol field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `inputInterfaceIndex` union: Query operators for inputInterfaceIndex field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `outputInterfaceIndex` union: Query operators for outputInterfaceIndex field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `octets` union: Query operators for octets field of type UInt64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. A value past 2^53 is sent as a string of digits.
      - number
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'InBetween', required
        - `startValue` union, required
          - number
          - string
        - `endValue` union, required
          - number
          - string
    - `packets` union: Query operators for packets field of type UInt64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. A value past 2^53 is sent as a string of digits.
      - number
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'InBetween', required
        - `startValue` union, required
          - number
          - string
        - `endValue` union, required
          - number
          - string
    - `flowStartAt` union: Query operators for flowStartAt field of type DateTime64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `flowEndAt` union: Query operators for flowEndAt field of type DateTime64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `ingestedAt` union: Query operators for ingestedAt field of type DateTime64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `flowFormat` union: Query operators for flowFormat field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `samplingRate` union: Query operators for samplingRate field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `flowCount` union: Query operators for flowCount field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween.
      - number
      - object
        - `_type` 'NotEqual', required
        - `value` number, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` number, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'LessThan', required
        - `value` number, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` number, required
      - object
        - `_type` 'InBetween', required
        - `startValue` number, required
        - `endValue` number, required
    - `probeId` union: Query operators for probeId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `srcName` union: Query operators for srcName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `dstName` union: Query operators for dstName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `_id` union: Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `createdAt` union: Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
  - `select` NetworkFlowV1SelectSchema: Select schema for NetworkFlowV1. Set fields to true to include them in the response.
    - `projectId` boolean
    - `networkDeviceId` boolean
    - `exporterIp` boolean
    - `srcIp` boolean
    - `dstIp` boolean
    - `srcPort` boolean
    - `dstPort` boolean
    - `protocol` boolean
    - `inputInterfaceIndex` boolean
    - `outputInterfaceIndex` boolean
    - `octets` boolean
    - `packets` boolean
    - `flowStartAt` boolean
    - `flowEndAt` boolean
    - `ingestedAt` boolean
    - `flowFormat` boolean
    - `samplingRate` boolean
    - `flowCount` boolean
    - `probeId` boolean
    - `srcName` boolean
    - `dstName` boolean
    - `_id` boolean
    - `createdAt` boolean
  - `sort` NetworkFlowV1SortSchema: Sort schema for NetworkFlowV1. Only sortable fields are included.
    - `projectId` 'ASC' | 'DESC': Sort order for projectId field
    - `networkDeviceId` 'ASC' | 'DESC': Sort order for networkDeviceId field
    - `exporterIp` 'ASC' | 'DESC': Sort order for exporterIp field
    - `srcIp` 'ASC' | 'DESC': Sort order for srcIp field
    - `dstIp` 'ASC' | 'DESC': Sort order for dstIp field
    - `srcPort` 'ASC' | 'DESC': Sort order for srcPort field
    - `dstPort` 'ASC' | 'DESC': Sort order for dstPort field
    - `protocol` 'ASC' | 'DESC': Sort order for protocol field
    - `inputInterfaceIndex` 'ASC' | 'DESC': Sort order for inputInterfaceIndex field
    - `outputInterfaceIndex` 'ASC' | 'DESC': Sort order for outputInterfaceIndex field
    - `octets` 'ASC' | 'DESC': Sort order for octets field
    - `packets` 'ASC' | 'DESC': Sort order for packets field
    - `flowStartAt` 'ASC' | 'DESC': Sort order for flowStartAt field
    - `flowEndAt` 'ASC' | 'DESC': Sort order for flowEndAt field
    - `ingestedAt` 'ASC' | 'DESC': Sort order for ingestedAt field
    - `flowFormat` 'ASC' | 'DESC': Sort order for flowFormat field
    - `samplingRate` 'ASC' | 'DESC': Sort order for samplingRate field
    - `flowCount` 'ASC' | 'DESC': Sort order for flowCount field
    - `probeId` 'ASC' | 'DESC': Sort order for probeId field
    - `srcName` 'ASC' | 'DESC': Sort order for srcName field
    - `dstName` 'ASC' | 'DESC': Sort order for dstName field
    - `_id` 'ASC' | 'DESC': Sort order for _id field
    - `createdAt` 'ASC' | 'DESC': Sort order for createdAt field
  - `groupBy` NetworkFlowV1GroupBySchema: Group by schema for NetworkFlowV1. Only one field can be set to true for grouping.
    - `projectId` boolean: Group by projectId field. Only one field can be selected for grouping.
    - `networkDeviceId` boolean: Group by networkDeviceId field. Only one field can be selected for grouping.
    - `exporterIp` boolean: Group by exporterIp field. Only one field can be selected for grouping.
    - `srcIp` boolean: Group by srcIp field. Only one field can be selected for grouping.
    - `dstIp` boolean: Group by dstIp field. Only one field can be selected for grouping.
    - `srcPort` boolean: Group by srcPort field. Only one field can be selected for grouping.
    - `dstPort` boolean: Group by dstPort field. Only one field can be selected for grouping.
    - `protocol` boolean: Group by protocol field. Only one field can be selected for grouping.
    - `inputInterfaceIndex` boolean: Group by inputInterfaceIndex field. Only one field can be selected for grouping.
    - `outputInterfaceIndex` boolean: Group by outputInterfaceIndex field. Only one field can be selected for grouping.
    - `flowFormat` boolean: Group by flowFormat field. Only one field can be selected for grouping.
    - `samplingRate` boolean: Group by samplingRate field. Only one field can be selected for grouping.
    - `flowCount` boolean: Group by flowCount field. Only one field can be selected for grouping.
    - `probeId` boolean: Group by probeId field. Only one field can be selected for grouping.
    - `srcName` boolean: Group by srcName field. Only one field can be selected for grouping.
    - `dstName` boolean: Group by dstName field. Only one field can be selected for grouping.
    - `_id` boolean: Group by _id field. Only one field can be selected for grouping.
    - `createdAt` boolean: Group by createdAt field. Only one field can be selected for grouping.
  - `limit` number: Maximum number of items to return. Defaults to 10.
  - `skip` number: Number of items to skip for pagination. Defaults to 0.

## Response `200`

Successful response

- object
  - `data` NetworkFlowV1[]
    - `projectId` string, required: Project ID
    - `networkDeviceId` string, required: Network Device ID
    - `exporterIp` string, required: Exporter IP
    - `srcIp` string, required: Source IP
    - `dstIp` string, required: Destination IP
    - `srcPort` number, required: Source Port
    - `dstPort` number, required: Destination Port
    - `protocol` number, required: Protocol
    - `inputInterfaceIndex` number, required: Input Interface Index
    - `outputInterfaceIndex` number, required: Output Interface Index
    - `octets` string: Octets
    - `packets` string: Packets
    - `flowStartAt` string: Flow Start
    - `flowEndAt` string: Flow End
    - `ingestedAt` string: Ingested At
    - `flowFormat` string, required: Flow Format
    - `samplingRate` number, required: Sampling Rate
    - `flowCount` number, required: Flow Count
    - `probeId` string: Probe ID
    - `srcName` string, required: Source Name
    - `dstName` string, required: Destination Name
  - `count` number

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)