BLACK BOX SDKVM Modular KVM Extender Chassis User Manual
Introduction
This documentation provides details on how to interact with DESKVUE via REST APIs. These APIs allow third-party devices and software to control DESKVUE without needing access to the user interface.
API Overview
- GET Endpoints: Retrieve information about work spaces, monitors, connections, and user statuses.
- PUT Endpoints: Modify system states such as logging off users, forcing workspace changes, or replacing tile connections.
1.4.2 API Credentials
Field: Value
Username: C2cI7Eq0jTV7YmhE
Password:m!fxEe+8gS&Tdg9S
1.4.2.1 Port Used
This web service runs on port 9888
1.5 REST API Endpoints
The following REST API endpoints are provided for interaction with external system:
1.5.1 1. GET Version
Field: Description
Method: GET
Endpoint: /version
Description: This function can be used to get system level version information.
1.5.1.1 JSON Data
1.5.1.1.1 JSON REQUEST
- No data required
1.5.1.1.2 JSON RESPONSE
{ “api_version”: “1.0.21”,
“software_version”: “V1.5.0_r447”,
“manufacturing_partnumber”: “300-115-001”,
“serial_number”: “S1L1T70023M0029”,
“product_type”: “SDKVM”,
“product_brand”: “Black Box”,
“product_configuration”: “Multi Head”,
“system_architecture”: “x86_64”,
“kernel_version”: “6.8.0-52-generic”,
“pc_model”: “snuc-sdkvm”,
“ethernet_speed”: 1000,
“oem_serial”: “S1L1T70023M0029”,
“sw_compatability”: “0x03”,
“discovery_status”: “Managed”,
“manager_mac”: “00:8c:10:1c:c6:
1.5.2 2. GET Workspace Details
Field: Description
Method: GET
Endpoint: /workspace/detailed
Description: This function can be used to get json object with a detailed snapshot of the currently active workspace.
1.5.3.1 JSON Data
JSON Request: JSON Response
None: {“workspaces_id”:string
}
1.5.4 4. GET System Monitors
Field: Description
Method: GET
Endpoint: /system/monitors
Description: This function can be used to get a json array of objects which represent a detailed snapshot of the current monitor configuration.
1.5.4.1 JSON Data
1.5.4.1.1 JSON REQUEST
- No data required
1.5.4.1.2 JSON RESPONSE
[{
“connected”: true,
“diagonal_size”: 24.199999999999999,
“edid”:
“00ffffffffffff0022f06f32010101010d1b0103803420782a4ca5a7554da226105054210800b30095008100d1c0a9c081c0a940818028
3c80a070b023403020360006442100001a000000fd00323c1e5011000a202020202020000000fc00485020453234320a202020202000000
0ff00434e43373133304b31430a20200137020318b148101f04130302121167030c0010000022e2002b023a801871382d40582c45000644
2100001e023a80d072382d40102c458006442100001e011d007251d01e206e28550006442100001e011d00bc52d01e20b82855400644210
0001e8c0ad08a20e02d10103e9600064421000018000000000000000000000000002f”,
“head”: 1,
“interface”: “HDMI-1”,
“manufacturer”: “Hewlett Packard”,
“name”: “HP E242”,
“position”: {
“x”: 0,
“y”: 0
},
“primary”: true,
“resolution”: {
“r”: 59.950000000000003,
“x”: 1920,
“y”: 1200
},
“rotation”: “normal”
},
] 1.5.5 5. GET Users Connections Summary
Field: Description
Method: GET
Endpoint: /users/connections/summary Description This function can be used to get a list of allowed connections for the currently logged in user.
1.5.5.1 JSON Data
1.5.5.1.1 JSON REQUES
{
“connections”: [
“connection_name”: “TX_Shared_192.168.1.103”
},
{
“connection_id”: “1318”,
“connection_name”: “TX_Shared_192.168.1.181”
},
{
“connection_id”: “1260”,
“connection_name”: “TX_Shared_192.168.1.228”
},
{
“connection_id”: “1304”,
“connection_name”: “TX_Shared_Ext_192.168.1.14”
},
{
“connection_id”: “1303”,
“connection_name”: “TX_Shared_Ext_192.168.1.103”
},
{
“connection_id”: “1244”,
“connection_name”: “VM 113”
},
{
“connection_id”: “902”,
“connection_name”: “VM_Peformance_Test”
},
{
“connection_id”: “1330”,
“connection_name”: “VS-2101X_H264”
}
],
“user_id”: “246”,
“user_name”: “eloise”
}
1.5.6 6. GET Users Workspace Summary
Field :Description
Method : GET
Endpoint : /users/workspaces/summary Description This function can be used to get a list of allowed workspaces for the currently logged in user
1.5.6.1 JSON Data
1.5.6.1.1 JSON REQUEST
- No data required
1.5.6.1.2 JSON RESPONSE
{
“user_id”: “246”,
“user_name”: “eloise”,
“workspaces”: [
{
“workspace_description”: “example Quad On One Screen”,
“workspace_id”: “151”,
“workspace_name”: “exampleQuadOnOneScreen”
},
{
“workspace_description”: “example_monitor14”,
“workspace_id”: “133”,
“workspace_name”: “example_monitor14”
},
{
“workspace_description”: “example_same_connection”,
“workspace_id”: “263”,
“workspace_name”: “example_same_connection”
},
{
“workspace_description”: “”,
“workspace_id”: “8”,
“workspace_name”: “PIP Right”
},
{
“workspace_description”: “example Quad workspace mixed”,
“workspace_id”: “142”,
“workspace_name”: “example_quad_mixed”
},
{
“workspace_description”: “192.168.1.164”,
“workspace_id”: “306”,
“workspace_name”: “example_164_second_screen”
}
]
}
1.5.7 7. GET Users Workspace List
Field: Description
Method: GET
Endpoint: /users/workspaces/list
Description: This function can be used to get the list of all existing users along with associated workspaces that they are allowed to access.
1.5.7.1 JSON Dat
1.5.7.1.1 JSON REQUEST
- No data required
1.5.7.1.2 JSON RESPONSE
{
“kvm_users_workspaces_list”: [
{
“user_id”: “246”,
“user_name”: “eloise”,
“workspaces”: [
{
“workspace_description”: “”,
“workspace_id”: “108”,
“workspace_name”: “Extended_RDP_Win10”
},
{
“workspace_description”: “Quad On One Screen”,
“workspace_id”: “151”,
“workspace_name”: “QuadOnOneScreen”
},
{
“workspace_description”: “rdp_112”,
“workspace_id”: “384”,
“workspace_name”: “rdp_112”
},
{
“workspace_description”: “RLC-810A_H264”,
“workspace_id”: “385”,
“workspace_name”: “h264_workspace”
},
{
“workspace_description”: “video_wall_x4”,
“workspace_id”: “380”,
“workspace_name”: “video_wall_x4”
},
{
“workspace_description”: “video_wall_tile_centered”,
“workspace_id”: “456”,
“workspace_name”: “video_wall_tile_centered”
}
]
}
1.5.8 8. PUT Control Workspaces
Field: Description
Method: PUT
Endpoint : /control/workspaces
Description: This function can be used to launch a workspace.
1.5.8.1 JSON Data
JSON Request: JSON Response
{
“action”: “force_workspace”,
“workspace”: “workspace ID number”, “user”: “the username”: None
}
1.5.9 9. DEL Control Workspaces
Field: Description
Method: DEL
Endpoint: /control/workspaces
Description: This function can be used to terminate a workspace.
1.5.9.1 JSON Data for additional actions to combine with the termination
JSON Request: JSON Response
{
“action”: “show_osd”: None
{
“action”: “no_osd”: None
}
“action”: “black screen”: None
“action”: “default screen”: None
1.5.10 10. GET Control Use
Documents / Resources
 |
BLACK BOX SDKVM Modular KVM Extender Chassis [pdf] User Manual SDKVM, 300-115-001, SDKVM Modular KVM Extender Chassis, SDKVM, Modular KVM Extender Chassis, KVM Extender Chassis, Extender Chassis |