Skip to content

Get Device Configuration

Returns the latest cached runtime configuration for a single device, such as relay jog duration and RS485 baud rate.

This endpoint does not refresh the device and does not send any command to the device. Configuration data comes from the latest full refresh, configuration read, or confirmed configuration write cached by the service. If the device has not reported a configuration section, that section is omitted.

Endpoint

http
GET /wlte/v1/devices/{deviceId}/config

Authorization Requirements

ScopeRequiredDescription
device:readYesRead cached configuration for the target device

Request

Full URL:

http
GET {baseUrl}/wlte/v1/devices/{deviceId}/config

Request headers:

http
Authorization: Bearer {accessToken}
Accept: application/json

Path parameters:

ParameterTypeRequiredRule
deviceIdstringYesMust not be empty

Success Response

HTTP status:

text
200 OK

Response body:

json
{
  "code": "SUCCESS",
  "message": "OK.",
  "requestId": "req_001",
  "data": {
    "deviceId": "rek053537488",
    "relay": {
      "channels": [
        {
          "index": 1,
          "jogTimeSeconds": 1
        },
        {
          "index": 2,
          "jogTimeSeconds": 1.5
        }
      ]
    },
    "rs485": {
      "baudRate": 9600
    },
    "updatedAt": "2026-06-12T08:30:00Z"
  }
}

If the device exists but no cached configuration is available, relay, rs485, and updatedAt may be absent:

json
{
  "code": "SUCCESS",
  "message": "OK.",
  "requestId": "req_001",
  "data": {
    "deviceId": "rek053537488"
  }
}

Response data Schema

FieldTypeRequiredDescription
deviceIdstringYesUnique device identifier
relayobjectNoRelay configuration
relay.channelsarray<RelayChannelConfig>NoPer-relay configuration
relay.channels[].indexintegerYesRelay index, starting from 1
relay.channels[].jogTimeSecondsnumberYesJog duration in seconds
rs485objectNoRS485 configuration
rs485.baudRateintegerNoRS485 baud rate in bps
updatedAtstringNoConfiguration cache update time in RFC3339 UTC

Response Rules

  • This endpoint only reads cached data; it does not refresh the device
  • Offline devices can still return the last cached configuration
  • Sections are returned according to device capability and reported data; unreported sections are omitted
  • After modifying configuration, call this endpoint to read the cached configuration value known by the service

Error Responses

Possible responses:

  • 400 INVALID_REQUEST
  • 401 AUTH_REQUIRED
  • 401 AUTH_INVALID
  • 401 AUTH_EXPIRED
  • 403 AUTH_SCOPE_DENIED
  • 404 DEVICE_NOT_FOUND
  • 429 RATE_LIMITED
  • 500 INTERNAL_ERROR
Docs buildVersion v1.2.21-20260612-141814-62
Copyright © 2026 WLTE