Sensors
Fields with * are required.
Getting sensors
Get sensors.
GET https://api.control.serenicity.fr/api/v1/sensors
Return the list of your sensors.
[
{
"id": 54,
"type_fk": "DETOXIO",
"name": "Labo Debian Buster",
"mac_address": "00:11:22:e1:a2:26",
"public_ip": "1.1.1.1",
"local_ip": "192.168.1.186",
"installation_date": "2022-04-22T08:54:50.778Z",
"max_protected_device": 23,
"supervision": true,
"filtering": true,
"version": "D3.0.0",
"suid_fk": "123123123123",
"end_trial": "2022-06-20T22:00:00.000Z",
"status": "CONNECTED",
"hno_hours": [
21,
22,
23,
0,
1,
2,
3,
4,
5,
6
],
"timezone": "America/Guadeloupe",
"latitude": 42.12345678912345,
"longitude": 42.12345678912345,
"site": {
"id": 18,
"client_id": 1,
"name": "Laboratoire",
"latitude": 42.12345678912345,
"longitude": 42.12345678912345,
"address": "42 rue de Saint-Etienne",
"address_complement": null,
"mention_distribution": null,
"zip_code": "42000",
"city": "Saint-Etienne",
"country": "FR",
"city_lat_lng": {
"lat": 42.000,
"lng": 42.000
},
"timezone": "Europe/Paris"
},
"current_cyt": 100
},
{
"id": 1900,
"type_fk": "DETOXIO",
"name": "ENDER",
"mac_address": null,
"public_ip": "1.1.1.1",
"local_ip": null,
"installation_date": null,
"max_protected_device": null,
"supervision": true,
"filtering": false,
"version": null,
"suid_fk": "DTXVI20220101F47441",
"end_trial": null,
"status": "CONNECTED",
"hno_hours": [
1,
2,
3,
4,
5
],
"timezone": "Europe/Paris",
"latitude": 15.99869,
"longitude": -61.73434,
"site": {
"id": 18,
"client_id": 1,
"name": "Laboratoire",
"latitude": 42.12345678912345,
"longitude": 42.12345678912345,
"address": "42 rue de Saint-Etienne",
"address_complement": null,
"mention_distribution": null,
"zip_code": "42000",
"city": "Saint-Etienne",
"country": "FR",
"city_lat_lng": {
"lat": 42.000,
"lng": 42.000
},
"timezone": "Europe/Paris"
},
"current_cyt": 0
},
{
"id": 2,
"type_fk": "DETOXIO",
"name": "Labo Debian Bullseye",
"mac_address": "0a:22:11:a2:1a:2a",
"public_ip": "1.2.3.4",
"local_ip": "192.168.1.179",
"installation_date": "2022-04-22T08:51:24.901Z",
"max_protected_device": 22,
"supervision": true,
"filtering": true,
"version": "D3.0.0",
"suid_fk": "9210626100241",
"end_trial": "2022-06-21T00:00:00.000Z",
"status": "CONNECTED",
"hno_hours": [
23,
0,
1,
2,
3,
4,
5
],
"timezone": "Europe/Paris",
"latitude": 15.99869,
"longitude": -61.73434,
"site": {
"id": 18,
"client_id": 1,
"name": "Laboratoire",
"latitude": 42.12345678912345,
"longitude": 42.12345678912345,
"address": "42 rue de Saint-Etienne",
"address_complement": null,
"mention_distribution": null,
"zip_code": "42000",
"city": "Saint-Etienne",
"country": "FR",
"city_lat_lng": {
"lat": 42.000,
"lng": 42.000
},
"timezone": "Europe/Paris"
},
"current_cyt": 13
}
]Getting a specific sensor
Get sensor.
GET https://api.control.serenicity.fr/api/v1/sensors/:sensor_id
Return one of your sensors.
Path Parameters
{
"id": 54,
"type_fk": "DETOXIO",
"name": "Labo Debian Buster",
"mac_address": "00:11:22:e1:a2:26",
"public_ip": "1.1.1.1",
"local_ip": "192.168.1.186",
"installation_date": "2022-04-22T08:54:50.778Z",
"max_protected_device": 23,
"supervision": true,
"filtering": true,
"version": "D3.0.0",
"suid_fk": "123123123123",
"end_trial": "2022-06-20T22:00:00.000Z",
"status": "CONNECTED",
"hno_hours": [
21,
22,
23,
0,
1,
2,
3,
4,
5,
6
],
"timezone": "America/Guadeloupe",
"latitude": 15.99869,
"longitude": -61.73434,
"site": {
"id": 18,
"client_id": 1,
"name": "Laboratoire",
"latitude": 42.12345678912345,
"longitude": 42.12345678912345,
"address": "42 rue de Saint-Etienne",
"address_complement": null,
"mention_distribution": null,
"zip_code": "42000",
"city": "Saint-Etienne",
"country": "FR",
"city_lat_lng": {
"lat": 42.000,
"lng": 42.000
},
"timezone": "Europe/Paris"
},
"current_cyt": 13
}{
"code": "E_SENSOR_NOT_FOUND",
"message": "Sensor not found."
}Getting statistics
The statistics metrics are grouped by month for each sensor.
The start_of_month_tz field represents the start time of the month at the local time of the sensor (defined by the site's time zone).
Get sensor statistics.
GET https://api.control.serenicity.fr/api/v1/sensors/:sensor_id/statistics
Return the statistics for one of your sensors.
Path Parameters
[
{
"sensor_id": 54,
"start_of_month_tz": "2022-09-30T22:00:00.000Z",
"in_flux": 321731521265,
"out_flux": 19580273143,
"toxic_in_flux": 161541,
"toxic_out_flux": 48919,
"in_count": 7812,
"out_count": 113036,
"toxic_in_count": 883,
"toxic_out_count": 9,
"bruteforce": 650,
"command_center": 40,
"hcard": 7,
"military": 0,
"sip": 8,
"supply_chain_compromise": 0,
"tor_node": 9,
"trojan": 4,
"video": 0
},
{
"sensor_id": 54,
"start_of_month_tz": "2022-08-31T22:00:00.000Z",
"in_flux": 45674954329,
"out_flux": 429192905,
"toxic_in_flux": 22149,
"toxic_out_flux": 4073,
"in_count": 692,
"out_count": 12678,
"toxic_in_count": 173,
"toxic_out_count": 1,
"bruteforce": 130,
"command_center": 5,
"hcard": 0,
"military": 0,
"sip": 0,
"supply_chain_compromise": 0,
"tor_node": 1,
"trojan": 0,
"video": 0
}
]{
"code": "E_SENSOR_NOT_FOUND",
"message": "Sensor not found."
}Last updated