ONoneuptime
Network Flow

List Network Flow

Endpoint to list all Network Flow items

post/network-flow/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "flowStartAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    }
  },
  "select": {
    "projectId": true,
    "networkDeviceId": true,
    "exporterIp": true
  },
  "sort": {
    "flowStartAt": "DESC"
  },
  "groupBy": {
    "projectId": true
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "projectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "networkDeviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "exporterIp": "Example text value",
      "srcIp": "Example text value",
      "dstIp": "Example text value",
      "srcPort": 42,
      "dstPort": 42,
      "protocol": 42,
      "inputInterfaceIndex": 42,
      "outputInterfaceIndex": 42,
      "octets": "example_value",
      "packets": "example_value",
      "flowStartAt": "example_value",
      "flowEndAt": "example_value",
      "ingestedAt": "example_value",
      "flowFormat": "Example text value",
      "samplingRate": 42,
      "flowCount": 42,
      "probeId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "srcName": "Example text value",
      "dstName": "Example text value"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.