Flux

For all flux queries, you have a pagination that allows you to retrieve the data.

"meta": {
    "total": 122170,
    "per_page": 100,
    "current_page": 1,
    "last_page": 1222,
    "first_page": 1,
    "first_page_url": "/?page=1",
    "last_page_url": "/?page=1222",
    "next_page_url": "/?page=2",
    "previous_page_url": null
},

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

Name	Type	Description
sensor_id*	1

Query Parameters

Name	Type	Description
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, start, sum_flux, 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.

200: OK List of flux

{
    "meta": {
        "total": 122170,
        "per_page": 100,
        "current_page": 1,
        "last_page": 1222,
        "first_page": 1,
        "first_page_url": "/?page=1",
        "last_page_url": "/?page=1222",
        "next_page_url": "/?page=2",
        "previous_page_url": null
    },
    "data": [
        {
            "start_of_hour": "2021-01-15T00:00:00.000Z",
            "duration": {
                "milliseconds": 37
            },
            "timestamps": [
                [
                    "2023-03-27T08:24:13.228Z",
                    "2023-03-27T08:24:13.265Z"
                ]
            ],
            "occurrences": 1,
            "last_netbios": "SoundTouch-CUISINE",
            "netbios_list": [
                "SoundTouch-CUISINE"
            ],
            "last_mac_address": "f4:5e:ab:8f:33:40",
            "mac_address_list": [
                "f4:5e:ab:8f:33:40"
            ],
            "ip0": "192.168.1.1",
            "toxic": true,
            "ip1": "51.51.51.51",
            "out_flux": 1234,
            "in_flux": 1234,
            "dir": "OUT",
            "port": 443,
            "protocol": "TCP",
            "filtered": true,
            "bruteforce": false,
            "command_center": false,
            "hcard": false,
            "military": false,
            "tor_node": false,
            "trojan": false,
            "sip": false,
            "video": false,
            "supply_chain_compromise": false,
            "custom_netbios": "My NAS",
            "vendor": "QNAP Systems, Inc."
        },
        ...
        {
            "start_of_hour": "2023-03-30T08:00:00.000Z",
            "duration": {
                "hours": 1,
                "minutes": 44,
                "seconds": 10,
                "milliseconds": 925
            },
            "timestamps": [
                [
                    "2023-03-30T08:04:22.911Z",
                    "2023-03-30T08:48:42.093Z"
                ],
                [
                    "2023-03-30T08:52:18.243Z",
                    "2023-03-30T09:48:46.249Z"
                ],
                [
                    "2023-03-30T08:48:52.147Z",
                    "2023-03-30T08:52:15.884Z"
                ]
            ],
            "occurrences": 3,
            "last_netbios": "NAS01",
            "netbios_list": [
                "NAS01"
            ],
            "last_mac_address": "24:5e:be:15:2a:az",
            "mac_address_list": [
                "24:5e:be:15:2a:az"
            ],
            "ip0": "192.168.1.2",
            "ip1": "74.207.241.132",
            "toxic": false,
            "out_flux": 40,
            "in_flux": 0,
            "dir": "OUT",
            "port": 443,
            "protocol": "TCP",
            "filtered": false,
            "bruteforce": true,
            "command_center": false,
            "hcard": false,
            "military": false,
            "tor_node": false,
            "trojan": false,
            "sip": false,
            "video": false,
            "supply_chain_compromise": false,
            "custom_netbios": null,
            "vendor": null
        }
    ]
}

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

Name	Type	Description
sensor_id*	1

Query Parameters

Name	Type	Description
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.

200: OK List of flux

{
    "meta": {
        "total": 123,
        "per_page": 100,
        "current_page": 1,
        "last_page": 2,
        "first_page": 1,
        "first_page_url": "/?page=1",
        "last_page_url": "/?page=2",
        "next_page_url": "/?page=2",
        "previous_page_url": null
    },
    "data": [
        {
            "start_of_hour": "2022-06-24T11:00:00.000Z",
            "ip0": "192.168.1.6",
            "last_netbios": "PRINTER",
            "netbios_list": ["PRINTER"],
            "last_mac_address": "84:ba:3b:50:7f:23",
            "mac_address_list": ["84:ba:3b:50:7f:23"],
            "in_flux": 213294,
            "out_flux": 276303,
            "in_count": 7,
            "out_count": 12,
            "toxic_in_flux": 88,
            "toxic_out_flux": 0,
            "toxic_in_count": 2,
            "toxic_out_count": 0,
            "bruteforce_count": 2,
            "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": 2,
            "custom_netbios": "Imprimante",
            "vendor": "CANON INC."
        },
        ...
        {
            "start_of_hour": "2022-06-23T06:00:00.000Z",
            "ip0": "192.168.1.73",
            "last_netbios": null,
            "netbios_list": [],
            "last_mac_address": null,
            "mac_address_list": [],
            "in_flux": 3305,
            "out_flux": 5105,
            "in_count": 0,
            "out_count": 1,
            "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_netbios": null,
            "vendor": null
        }
    ]
}

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

Name	Type	Description
sensor_id*	1

Query Parameters

Name	Type	Description
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.

200: OK List of flux

{
    "meta": {
        "total": 135,
        "per_page": 100,
        "current_page": 1,
        "last_page": 2,
        "first_page": 1,
        "first_page_url": "/?page=1",
        "last_page_url": "/?page=2",
        "next_page_url": "/?page=2",
        "previous_page_url": null
    },
    "data": [
        {
            "start_of_hour": "2022-12-18T04:00:00.000Z",
            "ip0": "192.168.1.11",
            "last_netbios": "NAS01",
            "netbios_list": [
                "NAS01"
            ],
            "last_mac_address": "24:5e:be:15:2a:az",
            "mac_address_list": [
                "24:5e:be:15:2a:az"
            ],
            "in_flux": 213294,
            "out_flux": 276303,
            "in_count": 7,
            "out_count": 12,
            "toxic_in_flux": 88,
            "toxic_out_flux": 0,
            "toxic_in_count": 2,
            "toxic_out_count": 0,
            "bruteforce_count": 2,
            "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": 2,
            "custom_netbios": "Mon NAS",
            "vendor": "QNAP Systems, Inc."
        },
        {
            "start_of_hour": "2022-12-18T04:00:00.000Z",
            "ip0": "192.168.1.22",
            "last_netbios": "HP7740",
            "netbios_list": [
                "HP7740"
            ],
            "last_mac_address": "18:60:24:69:0f:ef",
            "mac_address_list": [
                "18:60:24:69:0f:ef"
            ],
            "in_flux": 3305,
            "out_flux": 5105,
            "in_count": 0,
            "out_count": 1,
            "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_netbios": null,
            "vendor": "Hewlett Packard"
        },
    ]
}