Getting the Configuration of a Specific Device
Query the detailed configuration of a specific device.
Request URL
GET {base_url}/device/openapi/v1/devices/{deviceId}/configRequest Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| Authorization | Yes | String | The valid access token for making API calls. The format should be Bearer {access_token}. |
| Parameter | Required | Type | Description |
|---|---|---|---|
| deviceId | Yes | Long | The unique ID of this device, which is returned when you add
the device. Note: If you did NOT save the
deviceID, you can query the device's ID using Search Specific Devices.
|
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object<Device_Config> | Detailed configuration of the queried device. |
| status | String | The result of the API request.
|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
- Device_Config
-
Parameter Type Description version String The configuration file version of this device. type String Only display when using TSL configuration file. properties String Only display for TSL configuration devices. The properties content can be referred to Configuration Properties. values String Only display for profile configuration devices. The profile content can be referred to default Profile template or create a custom Config template.
Examples
- Request example
- Query the detailed information of the device with ID "1739930666380779522"
- Response example
-
HTTP/1.1 200 OK { "data": { "version": "v1.2", "values": [ { "key": "dm_enable", "value": 1 }, { "key": "dm_type", "value": 0 }, { "key": "dm_mip_addr", "value": "https://milesight.com/device" }, { "key": "dm_dh_addr", "value": "" }, { "key": "autop_enable", "value": 1 }, { "key": "scene_prvw", "value": 0 }, { "key": "image_type", "value": 1 }, { "key": "show_track_line", "value": 1 }, { "key": "show_detect_line", "value": 1 }, { "key": "show_uturn_area", "value": 1 }, { "key": "show_detect_region", "value": 1 }, { "key": "show_shopping_cart", "value": 0 }, { "key": "work_mode", "value": 0 }, { "key": "install_height", "value": 3000 }, { "key": "max_target_height", "value": 2000 }, { "key": "min_target_height", "value": 1000 }, { "key": "child_filt_height", "value": 1300 }, { "key": "cart_full_height", "value": 750 }, { "key": "cart_empty_height", "value": 450 }, { "key": "track_mode", "value": 0 }, { "key": "person_detect_mode", "value": 0 }, { "key": "child_diff", "value": 0 }, { "key": "staff_detect", "value": 0 }, { "key": "staff_sensitivity", "value": 5 }, { "key": "group_count", "value": 0 }, { "key": "max_group_count", "value": 20 }, { "key": "shopping_cart_detect_en", "value": 0 }, { "key": "heatmap", "value": 0 }, { "key": "uturn_filter", "value": 1 }, { "key": "region_monitor", "value": 0 }, { "key": "rst_cum_count", "value": 0 }, { "key": "rst_day", "value": 7 }, { "key": "rst_time", "value": 0 }, { "key": "input_enable_count", "value": 0 }, { "key": "trig_stat", "value": 0 }, { "key": "digital_output_en", "value": 1 }, { "key": "sync_pulse_interval", "value": 100 }, { "key": "adults_in_pulse_en", "value": 0 }, { "key": "adults_in_pulse_width", "value": 100 }, { "key": "adults_out_pulse_en", "value": 0 }, { "key": "adults_out_pulse_width", "value": 200 }, { "key": "children_in_pulse_en", "value": 0 }, { "key": "children_in_pulse_width", "value": 300 }, { "key": "children_out_pulse_en", "value": 0 }, { "key": "children_out_pulse_width", "value": 400 }, { "key": "staff_in_pulse_en", "value": 0 }, { "key": "staff_in_pulse_width", "value": 500 }, { "key": "staff_out_pulse_en", "value": 0 }, { "key": "staff_out_pulse_width", "value": 600 }, { "key": "group_in_pulse_en", "value": 0 }, { "key": "group_in_pulse_width", "value": 700 }, { "key": "group_out_pulse_en", "value": 0 }, { "key": "group_out_pulse_width", "value": 800 }, { "key": "manual_pulse_en", "value": 1 }, { "key": "manual_pulse_width", "value": 5000 }, { "key": "ip_assign", "value": 1 }, { "key": "ip_addr", "value": "192.168.5.220" }, { "key": "subnet_mask", "value": "255.255.255.0" }, { "key": "default_gateway", "value": "192.168.5.1" }, { "key": "prim_dns_server", "value": "8.8.8.8" }, { "key": "second_dns_server", "value": "114.114.114.114" }, { "key": "http_enable", "value": 1 }, { "key": "http_port", "value": 80 }, { "key": "https_port", "value": 443 }, { "key": "dot1x_enable", "value": 0 }, { "key": "dot1x_auth_type", "value": 0 }, { "key": "dot1x_eapol", "value": 0 }, { "key": "dot1x_identity", "value": "" }, { "key": "dot1x_password", "value": "" }, { "key": "dot1x_ca_cert", "value": "", "fileSize": "", "md5": "", "crc32": "" }, { "key": "dot1x_client_cert", "value": "", "fileSize": "", "md5": "", "crc32": "" }, { "key": "dot1x_private_key", "value": "", "fileSize": "", "md5": "", "crc32": "" }, { "key": "dot1x_private_passwd", "value": "" }, { "key": "recipient", "value": "" }, { "key": "dev_name", "value": "People Counter" }, { "key": "cus_dev_id", "value": "" }, { "key": "cus_site_id", "value": "" }, { "key": "time_zone", "value": 14 }, { "key": "dst_enable", "value": 0 }, { "key": "dst_start_month", "value": 3 }, { "key": "dst_start_week_no", "value": 5 }, { "key": "dst_start_week_day", "value": 0 }, { "key": "dst_start_time", "value": 120 }, { "key": "dst_end_month", "value": 10 }, { "key": "dst_end_week_no", "value": 5 }, { "key": "dst_end_week_day", "value": 0 }, { "key": "dst_end_time", "value": 180 }, { "key": "dst_bias_time", "value": 60 }, { "key": "sync_mode", "value": 1 }, { "key": "ntp_server_addr", "value": "pool.ntp.org" }, { "key": "ntp_syn_interval", "value": 1440 }, { "key": "ssh_enable", "value": 1 }, { "key": "tof_freq_adjust", "value": 0 }, { "key": "tof_light_mode", "value": 2 }, { "key": "schedule_start_time", "value": 32400 }, { "key": "schedule_end_time", "value": 79200 }, { "key": "confidence_switch", "value": 0 }, { "key": "confidence_value", "value": 2 }, { "key": "hard_rst", "value": 0 } ] }, "status": "Success", "requestId": "c15d037ea4c74565ecced1725c8d46d6" }