Device Configuration

This part of Device API describes how to manage device configuration parameters.

Get Configuration CloudGateway

GET /v3/devices/{device_id}/configuration/{group_name}

Retrieves the values of the current configuration parameters.

Request

$ curl http://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/configuration/network

Query Parameters

param_namesarray of strings

Comma-separated list of configuration parameters to show.

Response

{
    "configuration": {
        "uri": "port://rs485",
        "port": 502,
        "modbus_address": 2
    }
}

configurationobject

Object that contains the requested device configuration parameters.

Update Configuration CloudGateway

PATCH /v3/devices/{device_id}/configuration/{group_name}

Changes and resets the values of the specified configuration parameters.

Request

$ curl -X PATCH \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    http://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/configuration/network \
    -d '{
            "set": {
                "uri": "port://rs232",
                "port": 8502
            },
            "reset": ["modbus_address"]
        }'

Body Parameters

setobject

Object that contains the device configuration parameters with the new values.

resetarray of strings

Array that contains the names of device configuration parameters to reset.

Response

{
    "configuration": {
        "uri": "port://rs232",
        "port": 8502,
        "modbus_address": 1
    }
}

configurationobject

Object that contains the updated device configuration.

Reset All Configuration CloudGateway

POST /v3/devices/{device_id}/configuration/{group_name}/reset_all

Resets all configuration parameter values to their defaults.

Request

$ curl -X POST \
    http://api.enapter.com/v3/devices/fecbbba0-79f2-4e9e-a6f0-69a310ab110b/configuration/network/reset_all

Response

{
    "configuration": {
        "port": 502,
        "modbus_address": 1
    }
}

configurationobject

Object that contains the updated device configuration. If a parameter does not have a default value, its value will be deleted.