Get device setting capabilities

POST

/op/v1/device/setting/capability/get

Call this endpoint before GET or SET. It returns only the setting groups and fields supported by the specified device.

How to use the response:

Use group and field exactly as returned; they are case-sensitive public identifiers.

mode=SINGLE: GET requires one field; SET requires exactly one entry in values.

mode=BLOCK: GET omits field; SET must contain exactly every field in requiredFields.

Check group-level and field-level readable/writable before calling GET/SET.

For SET, use the native JSON type in dataType. Apply enum, range, and precision constraints when present.

The same group name may expose different fields on different devices. Always use the fields returned for the specified SN.

If groups is empty, the device does not support any setting exposed by this API.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "sn": "DEVICE_SN"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/op/v1/device/setting/capability/get' \
--header 'token;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'lang;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "sn": "DEVICE_SN"
}'

Responses

🟢200

application/json

Business response. Check errno even though the HTTP status is 200.

Bodyapplication/json

Example

{
    "errno": 0,
    "msg": "Operation successful",
    "result": {
        "groups": [
            {
                "group": "basicParameter1",
                "mode": "SINGLE",
                "readable": true,
                "writable": true,
                "fields": [
                    {
                        "field": "password",
                        "readable": true,
                        "writable": true,
                        "required": false,
                        "dataType": "number",
                        "precision": 1,
                        "range": {
                            "min": 0,
                            "max": 9999
                        }
                    }
                ]
            }
        ]
    }
}

Modified at 2026-09-02 03:05:18

client mode onboard

Read device settings