api.entel.sgc-services.com Open in urlscan Pro
18.67.39.123  Public Scan

Form analysis
0 forms found in the DOM

Text Content

{"openapi":"3.0.0","info":{"description":"Welcome to the Sagemcom Smart Services API reference. This is the docmentation for all the smart services API.\n\nSmart Services are organised around: Smart manage, Smart wifi, Smart ott and uses [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer) methodology. Smart Services API uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an `api-key` which can be obtained from your developer dashboard.\n","title":"Sagemcom Smart Services","version":"entel-5.1.1-stable-59b05621"},"tags":[{"name":"API","description":""},{"name":"Actions","description":""},{"name":"Advanced Search","description":""},{"name":"Analytics","description":""},{"name":"Commands","description":""},{"name":"DeviceType","description":""},{"name":"Devices","description":""},{"name":"Groups","description":""},{"name":"Hibernation mode","description":""},{"name":"Homes","description":""},{"name":"Plaform","description":""},{"name":"Platform","description":""},{"name":"RGPD","description":""},{"name":"Tags","description":""},{"name":"Users","description":""}],"schemes":["https"],"paths":{"/api/version":{"get":{"summary":"Get API version information (version number and changelog).","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["API"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"revision":"1.0.0 (abcdef)","changelog":"Fix bugs","features":"video,network"}}}}}}}},"/api/iot/attach-identity/{identity_id}":{"post":{"summary":"Attach current user identity to MQTT broker, in order to be able to subscribe to messages.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["API"]}},"/api/history/search":{"post":{"summary":"Search the history of API calls.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["API"],"description":"All fields in body are optional. Dates are given in strict_date_optional_time format.","responses":{"200":{"content":{"application/json":{"schema":{"example":{"api_calls":[{"user":"9e116344-40b0-4de9-b23b-67ad894c853a","group":"opteam","timestamp":123456,"method":"PUT","route":"/tag/1/devices","payload":"{\"tag_value\": \"XYZ\", \"devices\": [\"xx\", \"yy\"]}"}]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"username":"9e116344-40b0-4de9-b23b-67ad894c853a","group":"opteam","method":"PUT","route":"/tag/*/devices","payload":"'tag_value': 'XYZ'","from_time":"2018-10-16","to_time":"2018-10-17","size":10,"from_record":200}}}}}}},"/homes":{"get":{"summary":"Return all indexed homes.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"last_seen","schema":{"type":"integer"},"description":"(Optional) Only show homes which communicated during this period (in ms)."},{"in":"query","name":"show_disconnected","schema":{"type":"string"},"description":"(Optional) Show homes that disconnected during the last_seen period (true|false)"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of results per page"}],"tags":["Homes"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"homes":[{"home_id":"b0e0a279-a87f-4e06-8886-ff02e889b648","first_seen":1522251535980.0,"last_seen":1522251535980.0,"last_time_stats_asked":1524211039000.0,"config":"WiFi AP","wan_ipv4":"192.168.1.176"},{"home_id":"79f1ef14-4759-4e3c-ad7e-a1d6d3936d86","last_seen":1522251545623.0,"first_seen":1522251545623.0,"wan_ipv4":"192.168.1.30","config":"eth"}],"all_count":10,"last_seen":84600}}}}}}}},"/homes/search/{keyword}":{"get":{"summary":"Search a home by identifier, device, serial number or mac address.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"last_seen","schema":{"type":"integer"},"description":"(Optional) Only show homes which communicated during this period (in ms)."},{"in":"query","name":"show_disconnected","schema":{"type":"string"},"description":"(Optional) Show homes that disconnected during the last_seen period (true|false)"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of answers per page"}],"tags":["Homes"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"homes":[{"home_id":"b0e0a279-a87f-4e06-8886-ff02e889b648","full_name":"John Doe","first_seen":1522251535980.0,"last_seen":1522251535980.0,"last_time_stats_asked":1524211039000.0,"wan_ipv4":"192.168.1.176"},{"home_id":"79f1ef14-4759-4e3c-ad7e-a1d6d3936d86","full_name":"Jane Done","last_seen":1522251545623.0,"first_seen":1522251545623.0,"wan_ipv4":"192.168.1.30"}]}}}}}}}},"/home/{home_id}/network":{"get":{"summary":"Get devices topology for a given home.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"last_seen","schema":{"type":"integer"},"description":"(Optional) Only show devices which communicated during this period (in s)."}],"tags":["Homes"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"network":"...","TV":"...","digest":"..."}}}}}}}},"/home/{home_id}/set-ui-mode":{"get":{"summary":"Ask all home's devices to switch to 'UI mode' (This will work only if the device is 'MQTT connected' AND not in hibernate mode). In return, we get a 'digest' that we can use to make some cache (not reasking if nothing changed).","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"ui_mode_duration","schema":{"type":"integer"},"description":"(Optional, requires alt agent) Number of seconds during which the home's device should stay in UI monitoring mode."}],"tags":["Homes"]}},"/home/{home_id}/devices":{"get":{"summary":"Get device services of a given home.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"last_seen","schema":{"type":"integer"},"description":"(Optional) Only show devices which communicated during this period (in s)."}],"tags":["Homes"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"discoveries":"..."}}}}}}}},"/devices":{"get":{"summary":"Get the list of all devices, with group and tags. Use query paramameters `page=2' & 'page_size=20` for pagination","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of devices per page"},{"in":"query","name":"keyword","schema":{"type":"string"},"description":"(Optional) Only return devices with serial numbers containing the keyword"},{"in":"query","name":"mac","schema":{"type":"string"},"description":"(Optional) Only return devices with MAC address containing this string"},{"in":"query","name":"group","schema":{"type":"int"},"description":"(Optional) Restrict to devices in this group"},{"in":"query","name":"tag","schema":{"type":"string"},"description":"(Optional) Restrict to devices in this tag"},{"in":"query","name":"type","schema":{"type":"string"},"description":"(Optional) Restrict to devices of this type"},{"in":"query","name":"model","schema":{"type":"string"},"description":"(Optional) Restrict to devices of this model"},{"in":"query","name":"hw_id","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this hardware ID"},{"in":"query","name":"usage_id","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this usage ID"},{"in":"query","name":"monitoring_mode","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this monitoring mode"},{"in":"query","name":"firmware","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this firmware version"},{"in":"query","name":"user_agent","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this agent version"},{"in":"query","name":"system","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this device system"},{"in":"query","name":"system_version","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this device system version"},{"in":"query","name":"with_crashlogs","schema":{"type":"boolean"},"description":"(Optional) Only return devices with crash logs"}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"devices":[{"serial_number":"12345","last_checkin":"2019-09-10 16:05:13.000","group":{"group_name":"groupName","group_alias":"groupAlias","group_id":0,"is_default":false,"monitoring_mode":3},"home_id":"xxx","device_type":"STB","system":"android","connexion":"connected","ethernet_connected":false,"wifi_connected":true}]}}}}}}}},"/devices/export/csv/all":{"post":{"summary":"Export the whole list of devices to CSV file","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/devices/export/csv":{"get":{"summary":"Export the list of devices to CSV file. Use query paramameters `offset=50' & 'limit=100` for pagination","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"offset","schema":{"type":"integer"},"description":"(Optional) Number of devices to skip"},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"(Optional) Number of devices to show"},{"in":"query","name":"keyword","schema":{"type":"string"},"description":"(Optional) Only return devices with serial numbers containing the keyword"},{"in":"query","name":"mac","schema":{"type":"string"},"description":"(Optional) Only return devices with MAC address containing this string"},{"in":"query","name":"group","schema":{"type":"int"},"description":"(Optional) Restrict to devices in this group"},{"in":"query","name":"type","schema":{"type":"string"},"description":"(Optional) Restrict to devices of this type"},{"in":"query","name":"model","schema":{"type":"string"},"description":"(Optional) Restrict to devices of this model"},{"in":"query","name":"hw_id","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this hardware ID"},{"in":"query","name":"usage_id","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this usage ID"},{"in":"query","name":"monitoring_mode","schema":{"type":"string"},"description":"(Optional) Restrict to devices with this monitoring mode"}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":"divices.csv file"}}}}}}},"/devices/search/{keyword}":{"get":{"summary":"Search the list of all devices.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"keyword_type","schema":{"type":"string"},"description":"(Opt.) 'serial' (default) or 'mac'"},{"in":"query","name":"hardware_id","schema":{"type":"string"},"description":"(Opt.) Hardware id of the devices"},{"in":"query","name":"usage_id","schema":{"type":"string"},"description":"(Opt.) Usage id of the devices"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Opt.) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Opt.) Number of answers per page"}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"devices":["serial_number1","serial_number2"]}}}}}}}},"/device/{serial_number}":{"get":{"summary":"Get information on one device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"device":{"serial_number":"12345","device_type":"STB","hardware_id":"54AA","usage_id":"0010","firmware":"1.4b","user_agent":"analytics_collector 0.0.11","system":"android","system_version":"Android 10.1","mac_address":"01:23:45:67:89:AB","mac_address_wifi":"24:20:c7:10:20:39","home_id":"xxx","assets":["netflix","playready"],"crashlogs":{"module":"MOD_1","crash_time":"2020-07-16 15:44:26","fw_version":"4.5.6"},"group":{"group_name":"groupname","group_alias":"groupalias","group_id":1,"monitoring_mode":0,"is_default":false},"last_checkin":"2019-09-10 16:05:13.000","first_seen":"2017-04-02 16:30:00.000","user_agreement_sana":1,"user_api_consent_reason":1,"user_agreement_sana_service_list":["WiFi","Network","Apps","System","Bluetooth"],"current_stb_to_gw_link":"wlan0","current_stb_to_gw_link_timestamp":"2019-09-10 16:05:13.000","stb_attached_to_sb":[{"mac_address":"24:20:c7:10:20:30","last_seen":1589448722},{"mac_address":"24:20:c7:10:20:31","last_seen":1589448888}],"last_group_change":1603193100,"tags":[{"tag_name":"tag1","tag_id":0},{"tag_name":"tag2","tag_id":1}],"data":{"stuff_from":"dynamoDB"}}}}}}}}},"patch":{"summary":"Update device configuration.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"home_id","schema":{"type":"string"},"description":"(Optional) Home ID of the device"}],"tags":["Devices"],"description":"Body should contain a map of key/values"}},"/device/{serial_number}/delete":{"get":{"summary":"Remove a device from aurora db","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"removed":"ok"}}}}}}}},"/device/{serial_number}/action_logs":{"get":{"summary":"Send logs on the last actions made on the device","operationId":"get_device_actions","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/set-ui-mode":{"get":{"summary":"Ask the device to switch to UI mode (which allows the device to send a lot of things : stats, processes...). This will work only if the device is \"MQTT connected\" AND not in hibernate mode.","operationId":"set_device_ui_mode","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/send-ui-directive":{"post":{"summary":"Send UI directive to the device via MQTT. IT can be used to change the channel for example. This will work only if the device is \"MQTT connected\" AND not in hibernate mode.","operationId":"send_ui_directive","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"requestBody":{"content":{"application/json":{"schema":{"example":{"header":{"namespace":"Alexa.ChannelController","name":"ChangeChannel"},"payload":{"channel":{"number":7}}}}}}}}},"/device/{serial_number}/apps-list":{"get":{"summary":"Get the list of installed apps on the given device","operationId":"get_apps_list","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/running-apps-list":{"get":{"summary":"Get the list of running apps on the given device","operationId":"get_running_apps_list","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"ttl":1595386179.0,"system":"android","applications":[{"memoryUsed":"26980111","appVersion":"9","packageName":"Android System"},{"memoryUsed":"5692889","appVersion":"2.0.5-307484782-f","packageName":"Android TV Core Services"}],"useragent":"SgcAnalyticsAgent V0.0.5","serial_number":"919114400003","timestamp":1595382576120.0}}}}}}}},"/device/{serial_number}/foreground-apps-list":{"get":{"summary":"Get the list of foreground apps on the given device","operationId":"get_foreground_apps_list","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"ttl":1595386179.0,"system":"android","serial_number":"919114400003","useragent":"Android Agent v123","timestamp":1562161444516,"applications":[{"appVersion":"1.0.1","packageName":"Activity Stub","totalTime":"600"},{"appVersion":"15.26.34","packageName":"Youtube","totalTime":"3600"}]}}}}}}}},"/device/{serial_number}/system/processes":{"get":{"summary":"Get the system processes","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"since","schema":{"type":"integer"},"description":"(Optional) Observation period (in seconds). Defaults to 10."}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"system_processes":[]}}}}}}}},"device/{serial_number}/logs":{"post":{"summary":"DEPRECATED. Post the log token. NOTE: Still used by Altice/Bell Agents.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"home_id","schema":{"type":"string"},"description":"(Optional) home_id of the device"},{"in":"query","name":"file_name","schema":{"type":"string"},"description":"(Optional) if you want a specific file name"}],"tags":["Devices"]},"get":{"summary":"List a device's logs","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"Name:":"sgc.smartservices.dev.logs","Contents":[{"Key":"dev/device-data/123456789_2019-04-30_device-logs-1556630121.tar.gz","LastModified":"2019-05-16T11:48:58+00:00Z","Size":0},{"Key":"dev/device-data/123456789_2019-04-30_dmesg","LastModified":"2019-05-16T11:48:58+00:00Z","Size":0},{"Key":"dev/device-data/123456789_2019-04-30_video-logs-1556630121.zip","LastModified":"2019-05-16T11:48:58+00:00Z","Size":0}]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"continuation_token":"<TOKEN>"}}}}}}},"device/{serial_number}/haystack_logs":{"get":{"summary":"List a device's haystack logs","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"continuation_token","schema":{"type":"string"},"description":"token provided by AWS to continue listing the bucket from a previous point"}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"Name:":"sgc.smartservices.dev.logs","Contents":[{"Key":"dev/device-data/123456789_2019-04-30_device-logs-1556630121.tar.gz","LastModified":"2019-05-16T11:48:58+00:00Z","Size":0},{"Key":"dev/device-data/123456789_2019-04-30_dmesg","LastModified":"2019-05-16T11:48:58+00:00Z","Size":0},{"Key":"dev/device-data/123456789_2019-04-30_video-logs-1556630121.zip","LastModified":"2019-05-16T11:48:58+00:00Z","Size":0}]}}}}}}}},"device/{serial_number}/logs-avplayer":{"get":{"summary":"List a device's logs","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"analytics/last-report/log":{"get":{"summary":"get the download url to the last analytics report log","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"key","schema":{"type":"string"},"description":"the key to download"}],"tags":["Analytics"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"log":{"key":"analytics/last-report/log_name.txt","url":"https://s3_url.tld/key"}}}}}}}}},"device/{serial_number}/useful-datas":{"get":{"summary":"Device's useful datas list","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"Name":"sgc.smartservices.dev.logs","Contents":[{"Key":"useful_datas/620483138732/","LastModified":"2021-09-10T12:21:03+00:00Z","Size":0},{"Key":"useful_datas/620483138732/audio/","LastModified":"2021-09-10T12:21:24+00:00Z","Size":0},{"Key":"useful_datas/620483138732/audio/620483138732_2021-08-10T08_34_01_device-logs_1628598841.tar.gz.enc","LastModified":"2021-09-10T13:51:39+00:00Z","Size":25664}]}}}}}}}},"device/{serial_number}/log":{"get":{"summary":"get the download url to the log","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"key","schema":{"type":"string"},"description":"the key to download"}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"log":{"key":"device1/log_name.txt","url":"https://s3_url.tld/key"}}}}}}}}},"device/{serial_number}/haystack":{"get":{"summary":"get the download url to the log","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":"encrypted file"}}}}}}},"device/{serial_number}/agent/{file}":{"post":{"summary":"Post the url to download agent","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/agent/get_files":{"get":{"summary":"Get the name of the files to download","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/cosmocats":{"get":{"summary":"Get the list of available cosmocats for this device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"cosmocats":[{"name":"sanad","categories":[{"name":"ANALYTICS_COLLECTOR"},{"name":"AVIO_SC_BUS_HELPER"}]},{"name":"audio_manager","categories":[{"name":"AUDIO_MANAGER"},{"name":"AUDIO_MANAGER_AMBIANCES"}]}]}}}}}}},"post":{"summary":"Send a JSON list of cosmocats from UI to a device (via mqtt) to activate them","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"message":"cosmocats has been sent to the device"}}}}}}}},"/device/{serial_number}/rcu":{"get":{"summary":"get the rcu infos for a device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"battery":2}}}}}}}},"/device/{serial_number}/hdmi":{"get":{"summary":"get the hdmi infos for a device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"time":"2021-11-25T16:30:23.750000Z","3d":"0","aspect_ratio":"ORIGINAL","auth_ko":0,"auth_ok":11,"cec":"true","color_depth":0.0,"color_space":"AUTO_AUTO","decode_errors":0,"definition":"3840x2160","displayErrors":0,"group_id":"153","hdcp_auth":"ok","hdcp_enable":true,"hdcp_state":12.0,"hdcp_state_meaning":"encryption_working","hdcp_version":"2.2","host":"621210000895","manufacturer":"TSB","model":"TOSHIBA-TV","model_id":"nso_5Q_01","on":0.0,"plugged":true,"product":"5920","refresh_rate":"60Hz","serial":"0x01010101","sw_version":"2.2.14","transmitting_encrypted":true,"vendor":"21090","volume":100.0}}}}}}}},"/device/{serial_number}/app-usage":{"get":{"summary":"Route using portal manager metric and aggregating it over a period of time given in input as a number of time to give the total time an app has been running over the device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"days","schema":{"type":"int"},"description":"(Optional) Period of times to now from which to aggregate the app usage"}],"tags":["Devices"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"apps":[{"name":"Netflix","time_s":600}]}}}}}}}},"/device/{serial_number}/status-osd":{"get":{"summary":"Get informations about OSD session","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/start-osd":{"post":{"summary":"Start OSD session","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/stop-osd":{"post":{"summary":"Stop OSD session","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/is-source-selected":{"get":{"summary":"Check if source is selected for the device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/power-state":{"get":{"summary":"Retrieve the last power_state system metric for the device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/avsession":{"get":{"summary":"Retrieve the last avplayer session metric for the device","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"]}},"/device/{serial_number}/clear-cache":{"post":{"summary":"Publish on the MQTT command-clear_cache topic","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Devices"],"requestBody":{"content":{"application/json":{"schema":{"example":{"package_name":"com.sagemcom.tv"}}}}}}},"/group/{group_id}/clear-cache":{"post":{"summary":"Publish on the MQTT command-clear_cache topic","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Groups"],"requestBody":{"content":{"application/json":{"schema":{"example":{"package_name":"com.sagemcom.tv"}}}}}}},"/groups":{"get":{"summary":"Get the list of all groups, with basic information about it.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"default_only","schema":{"type":"boolean"},"description":"(Optional) Only return default groups"},{"in":"query","name":"regular_only","schema":{"type":"boolean"},"description":"(Optional) Return all groups except default"},{"in":"query","name":"keyword","schema":{"type":"string"},"description":"(Optional) Only return groups with names containing the keyword"},{"in":"query","name":"monitoring_mode","schema":{"type":"string"},"description":"(Optional) Restrict to groups with this monitoring mode"},{"in":"query","name":"scope","schema":{"type":"int"},"description":"(Optional) Restrict to groups with this scope"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of answers per page"}],"tags":["Groups"],"description":"Use query paramameter `default_only=True` to get only default groups.","responses":{"200":{"content":{"application/json":{"schema":{"example":{"groups":[{"id":0,"name":"Production","alias_name":"Production Alias","description":"A description","scope":{"scope_id":1,"scope_name":"Bretagne"},"is_default":true,"monitoring_mode":2,"hardware_id":"3K","usage_id":"01","device_count":21457},{"id":1,"name":"User test","alias_name":"User test alias","description":"Another description","scope":{"scope_id":1,"scope_name":"Bretagne"},"is_default":false,"monitoring_mode":0,"hardware_id":"2N","usage_id":"03","device_count":5}]}}}}}}},"post":{"summary":"Create a group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Groups"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"group":{"id":0,"name":"Production","alias_name":"Production Alias Name","description":"Production group 2018","hardware_id":"5A5A","usage_id":"0066","scope_id":12}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Production","alias_name":"Production Alias Name","description":"Production group 2018","hardware_id":"5A5A","usage_id":"0066","scope_id":12}}}}}}},"/groups/search/{keyword}":{"get":{"summary":"Search the list of all groups.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of answers per page"},{"in":"query","name":"include_defaults","schema":{"type":"boolean"},"description":"(Optional) Should the default groups be included in the search"},{"in":"query","name":"hardware_id","schema":{"type":"string"},"description":"(Optional) Hardware id of the group's devices"},{"in":"query","name":"usage_id","schema":{"type":"string"},"description":"(Optional) Usage id of the group's devices"}],"tags":["Groups"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"groups":[{"id":0,"name":"group1"},{"id":1,"name":"group2"}]}}}}}}}},"/group/{group_id}":{"get":{"summary":"Get information about a group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Groups"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"group":{"id":0,"name":"Production","alias_name":"Production Alias Name","description":"Production group 2018","hardware_id":"54AA","usage_id":"0010","creation_date":"2008-09-15 15:53:00+05:00","count":50,"is_default":true,"agent_configuration":"Base64-encodable configuration blob","user_data":"Base64-encodable blob","monitoring_mode":2,"scope":{"scope_id":1,"scope_name":"Bretagne"},"assets":[{"asset_name":"netflix","asset_count":24},{"asset_name":"playready","asset_count":0}]}}}}}}}},"patch":{"summary":"Update a group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Groups"],"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Production","alias_name":"Production Alias Name","description":"Production group 2018","scope_id":3,"agent_configuration":"Base64-encodable configuration blob","user_data":"Base64-encodable configuration blob","monitoring_mode":2}}}}}},"delete":{"summary":"Delete a group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Groups"]}},"/group/{group_id}/devices":{"get":{"summary":"Get the list of all devices within a group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of devices per page"}],"tags":["Groups"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"devices":["serial_number1","serial_number2"]}}}}}}},"post":{"summary":"Add and/or remove a list of devices to a group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"selector_type","schema":{"type":"string"},"description":"(Optional) Type of the values used to specify the target devices. Valid types: 'serial' (default), 'mac'."},{"in":"query","name":"propagate_config","schema":{"type":"boolean"},"description":"(Optional) Propage changes to the target devices immediately. WARNING: There are no guarantees regarding execution and cost for large operations."}],"tags":["Groups"],"description":"Returns how many devices where added and removed. Invalid devices are those that should be both added and removed.","responses":{"200":{"content":{"application/json":{"schema":{"example":{"added":3,"removed":1,"invalid":2}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"to_add":["xx","yy","zz"],"to_remove":["xx","yy","zz"]}}}}}}},"/device_types":{"get":{"summary":"Create a default group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["DeviceType"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"device_types":[{"id":0,"name":"model device m33","hardware_id":"5A5A","usage_id":"0066"}]}}}}}}},"post":{"summary":"Create a default group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["DeviceType"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"group":{"id":0,"name":"DefaultGroup5A5A_0066","description":"Default group of devices with hardware id 5A5A and usage id 0066","hardware_id":"5A5A","usage_id":"0066"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"hardware_id":"5A5A","usage_id":"0066","name":"model device m33"}}}}}}},"/device_types/{device_types_id}":{"get":{"summary":"Get a device type.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["DeviceType"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"device_types":{"id":0,"name":"model device m33","hardware_id":"5A5A","usage_id":"0066"}}}}}}}},"delete":{"summary":"Create a default group.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["DeviceType"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"device_types":[{"id":0,"name":"model device m33","hardware_id":"5A5A","usage_id":"0066"}]}}}}}}}},"/group/{group_id}/log":{"post":{"summary":"DEPRECATED: Use POST /action/upload-file-request instead. NOTE: still used for Bell agent.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"file_name","schema":{"type":"string"},"description":"(Optional) if you want a specific file name"}],"tags":["Groups"]}},"/group/{group_id}/action_logs":{"get":{"summary":"Send logs on the last actions made on the group","operationId":"get_group_actions","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Groups"]}},"/tags":{"get":{"summary":"Get the list of all tag names and ids.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"keyword","schema":{"type":"string"},"description":"(Optional) Only return tags with names containing the keyword"},{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of answers per page"}],"tags":["Tags"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"tags":[{"id":0,"name":"SCREEN_RES"},{"id":1,"name":"USER_GROUP"}]}}}}}}},"post":{"summary":"Create a tag.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Tags"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"tag":{"id":0,"name":"USER_GROUP","description":"Identifies different user focus groups","creation_date":"2008-09-15 15:53:00+05:00"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"USER_GROUP","description":"Identifies different user focus groups"}}}}}}},"/tag/{tag_id}":{"get":{"summary":"Get information about a tag.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Tags"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"tag":{"id":0,"name":"action1","description":"Devices we want to group for doing action 1","creation_date":"2008-09-15 15:53:00+05:00","tagged_devices":128}}}}}}}},"delete":{"summary":"Delete a tag.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Tags"]},"patch":{"summary":"Update a tag.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Tags"],"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Video","description":"Video format tag"}}}}}}},"/tag/{tag_id}/devices":{"get":{"summary":"Get the list of all devices within a tag.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of devices per page"}],"tags":["Tags"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"devices":["123456","202020"]}}}}}}},"post":{"summary":"Add or remove a list of devices to a tag","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"selector_type","schema":{"type":"string"},"description":"(Opt.) Valid types: 'serial' (default), 'mac'."}],"tags":["Tags"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"added":2,"removed":2,"invalid":1}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"to_add":["xx","yy","zz"],"to_remove":["xx","yy","zz"]}}}}}}},"/tag/{tag_id}/action_logs":{"get":{"summary":"Send logs on the last actions made on the tag","operationId":"get_tag_actions","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Tags"]}},"/action/upload-file-request":{"post":{"summary":"Publish MQTT \u00abupload-file\u00bb message.","operationId":"request_local_file_from_devices","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"target","schema":{"type":"string"},"description":"either \"device\" or \"group\""},{"in":"query","name":"target_id","schema":{"type":"string or integer"},"description":"either a device ID (S/N) or a group ID"},{"in":"query","name":"local_filename","schema":{"type":"string"},"description":"what (local filename) the device should upload"}],"tags":["Actions"],"description":"Publish MQTT \u00abupload-file\u00bb message to a single device or a group of devices."}},"/commands":{"get":{"summary":"List all available commands.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Commands"],"description":"E.g: system_reboot, firmware_upgrade, custom_reset","responses":{"200":{"content":{"application/json":{"schema":{"example":{"commands":[{"name":"Request network maps","description":"","path":"network.map.monitor","params":[{"path":"duration","type":"integer"},{"path":"period","type":"integer"},{"path":"enable","type":"boolean"}]}],"command_presets":["activate_logs","request_system_processes"]}}}}}}},"post":{"summary":"Sends an asynchronous command to a target device or set of devices.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Commands"],"description":"\n        The body of the request MUST contain the 'target' and 'target_type' parameters as well as either 'command_name' or 'command_body' (but not both). If 'command_body' is provided, the 'method' parameter is required as well.\n        'target_type' can take the following values: DEVICE, HOME, GROUP and TAG.\n        'target' should respectively contain the serial number, home id, group id and tag id.\n        'method' can take the following values: 'get' or 'set'.\n    ","requestBody":{"content":{"application/json":{"schema":{"example":{"target":"123456789","target_type":"DEVICE","command_name":"factory_reset"}}}}}}},"/device/{serial_number}/commands/{command_name}":{"post":{"summary":"Send a standard set of commands to a single device.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"home_id","schema":{"type":"string"},"description":"(Optional) Home ID of the device"}],"tags":["Commands"],"description":"Allowed commands: activate_logs, request_system_processes."}},"/home/{home_id}/commands/{command_name}":{"post":{"summary":"Send a standard set of commands to a single home.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Commands"],"description":"Allowed commands: activate_network_monitoring, request_network_map."}},"/users":{"get":{"summary":"Get the list of all users.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of answers per page"},{"in":"query","name":"keyword","schema":{"type":"string"},"description":"(Optional) Only return users with name containing the keyword"},{"in":"query","name":"role","schema":{"type":"int"},"description":"(Optional) Restrict to users with this role"},{"in":"query","name":"scope","schema":{"type":"int"},"description":"(Optional) Restrict to users with this scope"}],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"users":[{"id":"e63e3b40-27e3-4069-91ce-19a7988d823f","name":"John Doe","email":"john.doe@example.com","role":{"id":1,"name":"api-administrator"},"scopes":[{"id":1,"name":"Bretagne"}]}]}}}}}}},"post":{"summary":"Create a new user.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"user":{"id":"e63e3b40-27e3-4069-91ce-19a7988d823f","first_name":"John","last_name":"Doe","name":"John Doe","email":"john.doe@example.com","enabled":true,"status":"FORCE_CHANGE_PASSWORD","role":{"id":1,"name":"api-administrator"},"scopes":[{"id":1,"name":"Bretagne"}],"lang":"US"},"unknown_scopes":[2]}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"first_name":"John","last_name":"Doe","email":"john.doe@example.com","role":1,"scopes":[1,2],"lang":"US"}}}}}}},"/users/search/{keyword}":{"get":{"summary":"Search the list of all users.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"users":[{"username":0,"full_name":"John Doe"},{"username":1,"full_name":"Tim Connor"}]}}}}}}}},"/user/{username}":{"get":{"summary":"Get a user's details","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"user":{"id":"e63e3b40-27e3-4069-91ce-19a7988d823f","first_name":"John","last_name":"Doe","name":"John Doe","email":"john.doe@example.com","enabled":true,"status":"FORCE_CHANGE_PASSWORD","role":{"id":1,"name":"api-administrator"},"scopes":[{"id":1,"name":"Bretagne"}],"lang":"US"}}}}}}}},"patch":{"summary":"Update user's data","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"user":{"id":"e63e3b40-27e3-4069-91ce-19a7988d823f","first_name":"John","last_name":"Doe","name":"John Doe","email":"john.doe@example.com","enabled":true,"last_reset_password":"1638813287","status":"FORCE_CHANGE_PASSWORD","role":{"id":1,"name":"api-administrator"},"scopes":[{"id":1,"name":"Bretagne"}],"lang":"US"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"role_id":1,"scopes_to_add":[1,20],"scopes_to_remove":[5]}}}}}},"delete":{"summary":"Delete a user.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"]}},"/user/{username}/last-reset-password":{"patch":{"summary":"Update a last reset password value.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Bretagne"}}}}}}},"/user/{username}/reset_password":{"post":{"summary":"Reset a user's password.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"]}},"/user/update-pgp":{"post":{"summary":"Update the public PGP key of the current user","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"]}},"/user/get-pgp":{"get":{"summary":"GET the public PGP key of the current user","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"]}},"/roles":{"get":{"summary":"Get the list of all roles.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of answers per page"}],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"roles":[{"id":1,"name":"admin","description":"Admin description"},{"id":2,"name":"manager","description":"Manager description"}]}}}}}}}},"/scopes":{"get":{"summary":"Get the list of all scopes.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"include_groups","schema":{"type":"boolean"},"description":"(Optional) Return the groups for each scope"},{"in":"query","name":"keyword","schema":{"type":"string"},"description":"(Optional) Only return tags with names containing the keyword"}],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"scopes":[{"id":123,"name":"Bretagne","description":"Description of the scope","groups":[{"group_id":1,"group_name":"MyGroup","group_alias":"MyGroupAlias"}]}]}}}}}}},"post":{"summary":"Create a scope.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"scope":{"id":123,"name":"Bretagne","description":"Description of the scope"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Bretagne","description":"Description of the scope"}}}}}}},"/scope/{scope_id}":{"get":{"summary":"Get detailed info about a sigle scope.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"scope":[{"id":123,"name":"Bretagne","description":"Description of the scope","groups":[{"group_name":"STB mod. 1 Breizh","group_alias":"STB mod. 1 Breizh","group_id":22},{"group_name":"GW mod. A Breizh","group_alias":"GW mod. A Breizh","group_id":35}],"users":[{"username":"e63e3b40-27e3-4069-91ce-19a7988d823f","name":"John Doe"}]}]}}}}}}},"patch":{"summary":"Update a scope.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"],"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Bretagne","description":"Description of the scope"}}}}}},"delete":{"summary":"Delete a scope (associated groups are NOT deleted).","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Users"]}},"/rgpd/rgpd-logs":{"get":{"summary":"Get the list of all the RGPD operations done on the environment (Extract or delete) ","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"page","schema":{"type":"integer"},"description":"(Optional) Result page number"},{"in":"query","name":"page_size","schema":{"type":"integer"},"description":"(Optional) Number of devices per page"}],"tags":["RGPD"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"logs":[]}}}}}}}},"/rgpd/delete/{serial_number}":{"delete":{"summary":"Delete a device from Sana for RGPD purpose","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["RGPD"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"status":"succedded"}}}}}}}},"/rgpd/extract/{serial_number}":{"get":{"summary":"Extract all the data from a device from S3 for RGPD purpose","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["RGPD"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"status":"succedded"}}}}}}}},"/suggests/devices":{"get":{"summary":"Get the suggests for devices search form","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[],"tags":["Advanced Search"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"model":["model1","model2"],"firmware":["6.1.8100.99aa","3.2.94-p1"],"user_agent":["analytics_collector 0.0.11","analytics_collector 0.0.14"],"system":["Linux","Android"],"system_version":["9","10"]}}}}}}}},"/platform/errors":{"get":{"summary":"Search the operating errors log.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"include_payload","schema":{"type":"string"},"description":"(Optional) Include payload in search result (true|false)"}],"tags":["Platform"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"errors":[{"uid":"f3ad3fcc-15e7-4822-aba5-9b8669e28cee","location":"discovery","timestamp":"2018-12-03T15:48:56.744837","type":"error type","message":"My error message","payload":{"key1":1,"key2":"sample"},"associated_device":"617492000632","associated_user":"NULL"}]}}}}}}}},"/platform/statistics/assets":{"get":{"summary":"Get statistics about assets. Body may contains one filter from the following list: group, hw_id+usage_id.","operationId":"wrap_function","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"group","schema":{"type":"int"},"description":"(Optional) Group ID to filter with."},{"in":"query","name":"hw_id","schema":{"type":"string"},"description":"(Optional) Hardware ID to filter with (request must also contain usage_id)"},{"in":"query","name":"usage_id","schema":{"type":"string"},"description":"(Optional) Usage ID to filter with (request must also contain hw_id)"}],"tags":["Plaform"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"device_count":125,"assets":{"netflix":51,"playready":10}}}}}}}}},"/device/{serial_number}/check-in":{"post":{"summary":"Send discovery data through HTTP on a daily basis","operationId":"device_checkin","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"serial_number","schema":{},"required":"true","description":"Identifier of the device to retrieve"}],"tags":["Hibernation mode"],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"group_id":1,"monitoring_mode":2,"user_data":"string value (could be a parsable JSON)","agent_configuration":"base64 encoded string","tags":{"key1":"valueA","key2":2},"wan_ip":"114.224.12.87"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"example":{"product":"stb","board":"DIW362","hardware_id":"3K","usage_id":"01","firmware":"1.0.4","mac_address":"40:65:78:4D:33:EE","asset_list":["playready","netflix"],"has_critical_logs":null}}}}}}}}}