Device

Owned by Ramya Raman (Unlicensed)
Last updated: Jun 24, 2024
13 min read

GET devices

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns list of all devices on connected and multicast enabled network.

Resource URL

http://{host}/api/2.0/devices/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/.json

[ { "Device": { "id": 1, "modified": "1617953281094", "is_conected_device": 0, "title": "Cloud License", "color": "", "sys_up_time": "0", "sys_running_time": "0", "current_time": "0", "stack_title": null, "series": "", "model": "", "serial": "", "version": "", "hardware_desc": "Cloud License", "capability_desc": "Customer 3", "license_sharing": 1, "total_weight": 0, "active_weight": 0, "active_decoders": 0, "active_recorders": 0, "active_descramblers": 0, "active_uncompressed": 0, "active_encoders": 0, "working_mode_id": 11, "current_active_image": null, "next_boot_image": null, "status_stack_title": null, "ntp_offset": -0.445, "ntp_offset_age": null, "ntp_drift": null, "ntp_sync": 1, "max_rec_time": "", "cur_rec_bandwidth": "", "status_id": 5, "ip_address": "", "licensed_features": 0, "active_licenses": 0, "total_licenses": 20, "license_expiration": null } }, { "Device": { "id": 9011, "modified": "1617953281465", "is_conected_device": 1, "title": "MCM9000-SN:9011", "color": "#32e3f8,#551d2a", "sys_up_time": "1617940816160", "sys_running_time": "12464920", "current_time": "1617953281080", "stack_title": "bbnvc", "series": "MCM-9000 Series", "model": "MCM-9000", "serial": "9011", "version": "5.2.6zf", "hardware_desc": "Intel(R) Xeon(R) Platinum 8124M CPU @ 3.00GHz (x16), 31 GB Ram", "capability_desc": "145 Channels", "license_sharing": 1, "total_weight": 120, "active_weight": 85, "active_decoders": 26, "active_recorders": 0, "active_descramblers": 8, "active_uncompressed": 0, "active_encoders": 1, "working_mode_id": 1, "current_active_image": null, "next_boot_image": null, "status_stack_title": "bbnvc", "ntp_offset": 0.009, "ntp_offset_age": 6, "ntp_drift": 1, "ntp_sync": 1, "max_rec_time": 0, "cur_rec_bandwidth": 0, "status_id": 4, "ip_address": "", "licensed_features": 254, "active_licenses": 9.7, "total_licenses": 0, "license_expiration": null } } ]

 

 

GET devices/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single device configuration.

Resource URL

http://{host}/api/2.0/devices/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired device. If the value is set to '0'(zero), it'll return the information of the device used to send the API.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/9011/.json

{ "Device": { "id": 9011, "modified": "1617953348722", "is_conected_device": 1, "title": "MCM9000-SN:9011", "color": "#32e3f8,#551d2a", "sys_up_time": "1617940816160", "sys_running_time": "12532180", "current_time": "1617953348340", "stack_title": "bbnvc", "series": "MCM-9000 Series", "model": "MCM-9000", "serial": "9011", "version": "5.2.6zf", "hardware_desc": "Intel(R) Xeon(R) Platinum 8124M CPU @ 3.00GHz (x16), 31 GB Ram", "capability_desc": "145 Channels", "license_sharing": 1, "total_weight": 120, "active_weight": 85, "active_decoders": 26, "active_recorders": 0, "active_descramblers": 8, "active_uncompressed": 0, "active_encoders": 1, "working_mode_id": 1, "current_active_image": 2, "next_boot_image": 2, "status_stack_title": "bbnvc", "ntp_offset": 0.009, "ntp_offset_age": 13, "ntp_drift": 1.2, "ntp_sync": 1, "max_rec_time": 0, "cur_rec_bandwidth": 0, "status_id": 4, "ip_address": "", "licensed_features": 254, "active_licenses": 9.7, "total_licenses": 0, "license_expiration": null, "statistics": { "cpu_freq": { "min": 3, "avg": 3, "max": 3 } }, "stacking_multicast": "229.10.10.1", "stacking_port": "65513", "cloud_license": "jkskjbnbdpqlm798745khjaebkjnc", "license_server_host": "", "disable_http_access": "0", "disable_ftp_access": "0", "disable_ftps_access": "0" } }

 

 

PUT devices/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Update device configuration, specified by the required {id} parameter. Must be running from the desired device.

Resource URL

http://{host}/api/2.0/devices/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired device.

Example Request

PUT 

  1. http://44.235.52.211/api/2.0/devices/9011/.json

{ "Device": { "id": 622, "is_conected_device": 1, "title": "IP:129 SN:622", "color": "#ffa9f2,#3c5573", "sys_up_time": "1384764815708", "sys_running_time": "11465130", "stack_title": "TheStack", "series": "MCM-9000 Series", "model": "MCM-9000", "serial": "0622", "version": "2.1.2", "hardware_desc": "Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz (x8), 7.9GB Ram", "capability_desc": "30 channels", "license_sharing": 1, "total_weight": 30, "current_active_image": 1, "next_boot_image": 1, "modified": "1384776281799", "status_stack_title": "TheStack", "ntp_offset": 0, "ntp_offset_age": 0, "ntp_drift": 0, "max_rec_time": 0, "cur_rec_bandwidth": 0, "status_id": 4, "active_weight": 30, "active_decoders": 30, "active_recorders": 0, "license_decoders": 30, "license_recorders": 140 } }

 

 

GET devices/command/softReset

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Restarts all software components. Unsaved configuration is kept.

Resource URL

http://{host}/api/2.0/devices/command/softReset/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/command/softReset/.json

 

 

GET devices/command/hardReset

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Full restart of the device. If a standalone system, configuration will return to last saved one, removing all unsaved changes. If device connected to stack, configuration will be kept, as long as at least one device on the stack stays up.

Resource URL

http://{host}/api/2.0/devices/command/hardReset/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/command/hardReset/.json

 

 

GET devices/command/shutDown

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Complete shutdown of the device.

Resource URL

http://{host}/api/2.0/devices/command/shutDown/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/command/shutDown/.json

 

 

GET devices/command/saveConfig

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Saves configuration of all devices on stack, if any defined.

Resource URL

http://{host}/api/2.0/devices/command/saveConfig/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/command/saveConfig/.json

 

 

GET devices/switchBootImage/{image_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Switch to the specified boot image for next system reboot.

Resource URL

http://{host}/api/2.0/devices/switchBootImage/{image_id}/.format

Parameters

Parameter

Data Type

Description

image_id
(required)

integer

The ID of the desired image to switch to.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/switchBootImage/2/.json

 

 

GET devices/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns list of device's meta data. Data includes DeviceStatusTypes and current available images.

Resource URL

http://{host}/api/2.0/devices/meta/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/devices/meta/.json