COEX150
English
  • 简体中文
  • English
  1. Device
COEX150
English
  • 简体中文
  • English
  • Contents
    • API Instructions
    • Error Codes
    • General API
      • Retrieve Screen Information
      • Set Screen Brightness
      • Set Screen Gamma
      • Set Blackout/Freeze Screen
      • Retrieve Preset Information
      • Apply Preset
      • Retrieve All Cabinet Information
      • Enable Cabinet Mapping
      • Adjust Cabinet Color Temperature
      • Switch Source for Layer
      • Configure EDID
      • Retrieve Real-Time Monitoring Information
    • Input
      • Internal sources
        • Set Internal Source Information
        • Set Sending Card Test Pattern
      • Retrieve Input Information
        • Retrieve Input Source Info
        • Retrieve Input Data
      • Color Adjustment
        • Set Red Shadow
        • Set Green Shadow
        • Set Blue Shadow
        • Set Red Highlight
        • Set Green Highlight
        • Reset Color Adjustment
        • Set Blue Highlight
        • Set Saturation
        • Set Contrast
        • Set Black Level
        • Adjust Hue
      • EDID
        • Set EDID
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Set Screen Color Temperature
        • Retrieve Screen Display Effect Parameters
        • Set Brightness Limit On/Off
        • Set Brightness Limit Value
        • Set Custom Gamma for the Screen
        • Set Screen Color Temperature
        • Set Screen Brightness
        • Set Screen Gamma
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Strategy
      • Color Correction
        • Set Color Correction On/Off
        • Set Color Correction Data (Black/White)
        • Set Color Correction Data (Other Colors)
      • Layer
        • Switch Source for Layer
      • Process
        • 3D LUT
          • Import 3D LUT File
          • Delete 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Retrieve Preset Information
        • Apply Preset
        • Modify Preset
      • Output
        • 3D
          • 3D Emitter
            • Enable 3D Emitter
          • Enable/Disable 3D
        • Retrieve Output Parameters
          • Retrieve Screen Output Data
        • Display Mode
          • Set Blackout/Freeze Screen
        • Multi-Mode
          • Set Multi-mode by Screens
        • Retrieve Display Status
        • Set Output Bit Depth
        • Output Sync Source Switching
      • Retrieve the Number of Cabinets of the Screen
      • Retrieve Screen Information
      • Retrieve Screen Properties Information
    • Device
      • Audio
        • Set Output Audio
        • Retrieve Audio Settings
      • Controller Identify
        • Controller Identify
      • Device Backup
        • Retrieve Device Backup Status
        • Primary/Backup Verify
      • Logs
        • Export Log
      • Controller Time
        • Set System Time
        • Automatic Time Setting On/Off
        • Change the time zone
      • Controller Name
        • Change Controller Name
      • SNMP
        • Retrieve SNMP On/Off Status
        • Set SNMP On/Off
      • Multifunction Card
        • Retrieve Multifunction Card Information
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
        PUT
      • Retrieve Device Information
        GET
    • Cabinet
      • Pre-stored Image
        • Set No Data Signal
      • Thermal Calibration
        • Set Thermal Compensation On/Off
        • Thermal Compensation Intensity Adjustment
        • Set Thermal Compensation Mode
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Adjust Color Temperature
        • Adjust Cabinet Color Temperature
      • Cabinet Display Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
      • Retrieve All Cabinet Information
      • Set Cabinet RGBW Brightness Components
  1. Device

Retrieve Device Information

GET
/api/v1/device/hw
TIP
Retrieve device information

Request

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://prod-cn.your-api-server.com/api/v1/device/hw' \
--header 'Device-Key: 10.40.41.200:8001' \
--header 'Content-Type: application/json'

Responses

🟢200Successful
application/json
Body

Example
{
    "name": "string",
    "customName": "string",
    "modelID": 0,
    "sn": "string",
    "productSn": "string",
    "subBoardInfo": {
        "inputSn": {
            "type": 0,
            "sn": "string",
            "modelId": 0
        }
    },
    "mac": "string",
    "type": "string",
    "hwVersion": "string",
    "swVersion": "string",
    "upgradeTime": 0,
    "configVersion": "string",
    "ip": "string",
    "mode": 0,
    "companyName": "string",
    "capability": {
        "processing": true,
        "allowChangeWorkMode": true,
        "preset": true,
        "presetNameCheck": true,
        "artNet": true,
        "layerNumberLimit": 0,
        "phaseShift": true,
        "isSupportModifyOpticalMode": true,
        "modifyLayerCoordinate": true,
        "supportLayerBorder": true,
        "supportLayerCut": true,
        "modifyLayerSize": true,
        "supportLayerScreenSize": true,
        "supportLayerStretch": true,
        "supportLayerSwitchSource": true,
        "supportLayerOriginSize": true,
        "canvasFrameRate": true,
        "modifyCurtainSize": true,
        "internalSourceImage": true,
        "controllerPosition": true,
        "supportPxToPx": true,
        "reset": true,
        "rotation": true,
        "mirror": true,
        "3D": true,
        "HDR10": true,
        "inputBackup": true,
        "sync": true,
        "genLock": true,
        "frameRateMultiplication": true,
        "shutterSync": true,
        "photoelectricConversion": true,
        "lowLatency": true,
        "additionalFrameDelay": true,
        "blackLevel": true,
        "xyzTxTestPattern": true,
        "baseImageCount": 0,
        "inputZoom": true,
        "negPosSupport": true,
        "maxCapacity": 0,
        "presetImage": true,
        "abnormalImage": true,
        "customTestImage": true,
        "inputImageEcho": true,
        "outputImageEcho": true,
        "HDCP": true,
        "limitToFull": true,
        "highLights": true,
        "shadow": true,
        "signalTransmitter": true,
        "ABL": true,
        "EDE": true,
        "ITMO": true,
        "colorReplace": true,
        "colorCalibration": true,
        "systemRestore": true,
        "3DLUT": true,
        "hwMapping": true,
        "projectFile": true,
        "PIP": true,
        "CSC": true,
        "inputAutoSwitch": true,
        "hdmiModeSetting": true,
        "frameRemaping": true,
        "noVideoSignal": true,
        "maxWidth": 0,
        "maxHeight": 0,
        "presetImageMaxNum": 0,
        "outputBitDepth": [
            0
        ],
        "colorSpaceType": [
            0
        ],
        "colorGamutType": [
            0
        ],
        "ncpManager": true,
        "customCabinetSpecs": true,
        "presetNumber": 0,
        "mosaic": {
            "mode": [
                {
                    "value": 0,
                    "comment": "string",
                    "inputType": [
                        0
                    ]
                }
            ]
        },
        "presetImageSize": {
            "width": 0,
            "height": 0
        },
        "presetImageSetInfo": {
            "maxWidth": 0,
            "maxHeight": 0
        },
        "additionalFrameDelayRange": {
            "min": 0,
            "max": 0,
            "step": 0
        },
        "frameRateMultiplicationRange": {
            "min": 0,
            "max": 0,
            "step": 0
        },
        "threeDRightEyeOffsetRange": {
            "min": 0,
            "max": 0,
            "step": 0
        },
        "HWMonitor": {
            "ArmSupported": true,
            "FansSupported": true,
            "FpgaSupported": true,
            "InputSubCardSupported": true,
            "MainBordSupported": true,
            "NetWordSubCardSupported": true,
            "OpticalCardSupported": true
        },
        "virtualMode": [
            0
        ],
        "NTP": true,
        "mfCardUpdate": true,
        "deviceLocation": true,
        "preStoreImage": true,
        "imageEnhance": true,
        "emailAlert": true,
        "supportColorBeacon": true,
        "isSupportCloud": true,
        "inputModeList": [
            0
        ],
        "curve": true
    },
    "hostName": "string",
    "ethMode": "string",
    "IpGateway": "string",
    "Dns": [
        "string"
    ],
    "IpNetmask": "string",
    "Series": 0,
    "uptime": 0,
    "memorySize": 0,
    "memoryUsed": 0,
    "memoryFree": 0,
    "deviceUUID": "string",
    "groupName": "string",
    "isAllowSingleDev": true,
    "dPCustomHDR10": true,
    "sdi12GCustomHDR10": "string",
    "randomPassword": "string",
    "updateState": 0,
    "isODMBuild": true,
    "isODMExclusive": true,
    "ODMVendorName": "string",
    "capacity": 0
}
Modified at 2025-10-21 01:43:57
Previous
Set Blackout/Freeze Screen
Next
Set No Data Signal
Built with