Flux
"meta": {
"total": 122170,
"per_page": 100,
"current_page": 1,
"last_page": 1222,
"first_page": 1
},Fields with * are required.
Flux by detail
Get all flux of a sensor between two dates.
GET https://api.control.serenicity.fr/api/v1/sensors/:sensor_id/flux
Return list of flux. Filtering options are available.
Path Parameters
sensor_id*
1
Query Parameters
from*
2022-01-01T00:00:00Z
Start date in ISO format
to*
2022-02-01T00:00:00Z
End date in ISO format
ip0
192.168.1.1
Filter with private IP/device
ip1
1.1.1.1
Filter with public IP
protocol
TCP
Filter on specific protocol
port
22
Filter on specific port
mac_address
00:15:5d:86:eb:5f
Filter on specific mac_address
only_toxic
true
Filter only toxic flux
only_in
true
Filter only ingoing flux
only_out
true
Filter only outgoing
sort_by
ip0
Sort by specific field. One of : ip0, ip1, startOfHour, sumFlux, dir, protocol, port
sort_desc
true
Sort desc according to sort by param
page
1
By default 1. The page has to be between last_page and first_page.
per_page
100
Number of flux per page. 100 by default.
{
"meta": {
"total": 122170,
"per_page": 100,
"current_page": 1,
"last_page": 1222,
"first_page": 1
},
"data": [
{
"start_of_hour": "2024-07-23T07:00:00.000Z",
"ip0": "192.168.1.10",
"ip1": "3.219.173.44",
"dir": "OUT",
"protocol": "TCP",
"port": 443,
"occurrences": 1,
"duration": {
"minutes": 35,
"seconds": 10,
"milliseconds": 13
},
"timestamps": [
[
"2024-07-23T07:14:01.854Z",
"2024-07-23T07:49:11.867Z"
]
],
"last_netbios": "TV",
"netbios_list": [
"TV"
],
"last_mac_address": "d8:e0:e1:69:d8:df",
"mac_address_list": [
"d8:e0:e1:69:d8:df"
],
"out_flux": "1260",
"in_flux": "0",
"filtered": false,
"toxic": false,
"bruteforce": false,
"command_center": false,
"hcard": false,
"military": false,
"tor_node": false,
"trojan": false,
"sip": false,
"supply_chain_compromise": false,
"video": false,
"custom_ip0": {
"id": 1341,
"sensor_id": 54,
"ip0": "192.168.1.10",
"name": "Télé salon",
"icon": "i-lucide-monitor-smartphone",
"is_critical": false,
"category": null,
"created_at": "2024-02-12T18:17:28.561946+01:00",
"updated_at": "2024-08-01T16:25:11.408+02:00"
},
"vendor": "Samsung Electronics Co.,Ltd"
}
]
}Flux by IP0 and hour
Flux are grouped by local IP (IP0) and hour.
There are statistics for each IP0/hour on the volumetry of ingoing/outgoing flux (in_flux, out_flux) and toxic flux (in_toxic_flux, out_toxic_flux).
There are the same statistics about the count of toxic and total count of flux (toxic_count, count).
You can also find the cyberweather (cyt).
Get all flux of a sensor grouped by hour and IP0 between two dates.
GET https://api.control.serenicity.fr/api/v1/sensors/:sensor_id/flux-hour-ip0
Return list of flux with statistics. Filtering options are available.
Path Parameters
sensor_id*
1
Query Parameters
from*
2022-01-01T00:00:00Z
Start date in ISO format
to*
2022-02-01T00:00:00Z
End date in ISO format
ip0
192.168.1.1
Filter with private IP/device
sort_by
ip0
Sort by specific field. One of : ip0, utc_hour
sort_desc
true
Sort desc according to sort by param
page
1
By default 1. The page has to be between last_page and first_page.
per_page
100
Number of flux per page. 100 by default.
{
"meta": {
"total": 123,
"per_page": 100,
"current_page": 1,
"last_page": 2,
"first_page": 1
},
"data": [
{
"start_of_hour": "2024-07-23T07:00:00.000Z",
"ip0": "192.168.1.10",
"last_netbios": "TV",
"netbios_list": [
"TV"
],
"last_mac_address": "d8:e0:e1:69:d8:df",
"mac_address_list": [
"d8:e0:e1:69:d8:df"
],
"in_flux": "5513879",
"out_flux": "753504",
"in_count": 1,
"out_count": 59,
"toxic_in_flux": "0",
"toxic_out_flux": "0",
"toxic_in_count": 0,
"toxic_out_count": 0,
"bruteforce_count": 0,
"command_center_count": 0,
"hcard_count": 0,
"military_count": 0,
"tor_node_count": 0,
"trojan_count": 0,
"sip_count": 0,
"supply_chain_compromise_count": 0,
"video_count": 0,
"cyt": 0,
"custom_ip0": {
"id": 1341,
"sensor_id": 54,
"ip0": "192.168.1.10",
"name": "Télé salon",
"icon": "i-lucide-monitor-smartphone",
"is_critical": false,
"category": null,
"created_at": "2024-02-12T18:17:28.561946+01:00",
"updated_at": "2024-08-01T16:25:11.408+02:00"
},
"vendor": "Samsung Electronics Co.,Ltd"
}
]
}Flux by hour
Flux are grouped by hour.
There are statistics for each hour on ingoing/outgoing volume (in_flux, out_flux) and toxic volume (in_toxic_flux, out_toxic_flux).
There are the same statistics about the count of toxic and total count of flux (toxic_count, count).
You can also find the cyberweather (cyt).
Get all flux of a sensor grouped by hour between two dates.
GET https://api.control.serenicity.fr/api/v1/sensors/:sensor_id/flux-hour-sensor
Return list of flux with statistics. Filtering options are available.
Path Parameters
sensor_id*
1
Query Parameters
from*
2022-01-01T00:00:00Z
Start date in ISO format
to*
2022-02-01T00:00:00Z
End date in ISO format
sort_by
ip0
Sort by specific field. One of : utc_hour
sort_desc
true
Sort desc according to sort by param
page
1
By default 1. The page has to be between last_page and first_page.
per_page
100
Number of flux per page. 100 by default.
{
"meta": {
"total": 135,
"per_page": 100,
"current_page": 1,
"last_page": 2,
"first_page": 1
},
"data": [
{
"start_of_hour": "2024-07-23T07:00:00.000Z",
"in_flux": "5641626",
"out_flux": "1021206",
"in_count": 8,
"out_count": 73,
"toxic_in_flux": "240",
"toxic_out_flux": "0",
"toxic_in_count": 1,
"toxic_out_count": 0,
"bruteforce_count": 1,
"command_center_count": 0,
"hcard_count": 0,
"military_count": 0,
"tor_node_count": 0,
"trojan_count": 0,
"sip_count": 0,
"supply_chain_compromise_count": 0,
"video_count": 0,
"cyt": 1
}
]
}Last updated