Network Flow
Get Network Flow
Endpoint to retrieve a single Network Flow by ID
post/network-flow/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Network Flow to retrieve
Request body
Example request
{
"select": {
"projectId": true,
"networkDeviceId": true,
"exporterIp": true
}
}Response
Successful response
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.