Configuration

Endpoint for receiving sensor configuration updates

Receive sensor configuration

post

Overview

This endpoint is used to report the current configuration settings stored in the sensor's memory. The CoAP Loader forwards this data to help you track and synchronize sensor settings with your platform.

Important: The endpoint paths shown in this documentation (/measurements, /configuration, /device-info) are examples only.

The actual endpoint URLs are fully configurable in the CoAP Loader's application.yml file

When is it called?

• During the first communication after sensor boot/reset

• Whenever a configuration change is detected on the device (hash value changes)

• After you remotely update sensor settings via the /measurements response

What data do you receive?

• Complete snapshot of all current sensor settings

• Configuration metadata: hash (version), timestamp, serialNumber

• Information about configuration split (if payload is divided into multiple parts)

Use cases:

• Synchronize your database with actual sensor settings

• Audit and track configuration changes over time

• Verify that remote configuration updates were applied successfully

Request Structure

Method: POST

Endpoint: Configurable in application.yml under the endpointConfiguration key. The path /configuration shown here is just an example.

Headers:

• Content-Type: application/json

• charset: UTF-8

• X-Api-Token: "optional api token" (if configured on sensor via CLOUD_TOKEN parameter)

Body: JSON object containing:

• serialNumber - Unique sensor identifier

• timestamp - Configuration timestamp

• hash - Configuration version (changes with every update). Important: If hash = "0", the sensor runs deprecated software.

• partsCount - Total number of configuration parts (for large configs)

• partIndex - Current part index (1-based)

• parameters - Array of configuration parameters. For detailed specification of all available parameter types, see ConfigurationParametersReference in the Models section.

Data Processing Notes

The CoAP Loader preprocesses the configuration data before forwarding:

• Duplicate parameters: If the sensor sends duplicate parameter types, the CoAP Loader keeps only the last occurrence and logs a warning

• Invalid parameters: Parameters that cannot be parsed are automatically removed and logged as errors - the remaining valid parameters are still forwarded to your API

• Partial data: Even if some parameters fail to parse, you will receive all successfully parsed parameters

Response

Your platform must respond with HTTP status code 2xx (e.g., 200, 201, or 204) with an empty body to confirm receipt.

Note: Unlike /measurements, this endpoint does NOT support returning configuration updates in the response.

Header parameters

X-Api-TokenstringOptional

Optional API token for authentication (if configured)

Example: your_api_token

Content-TypestringRequiredDefault: application/json

charsetstringRequiredDefault: UTF-8

Body

application/json

serialNumberstringRequired

Unique serial number of the sensor

Example: 282C024FFFB1

timestampstringRequired

Data timestamp

Example: 1

partsCountinteger · min: 1Required

Total number of parts the configuration is divided into

Example: 1

partIndexinteger · min: 1Required

Index of the currently transmitted configuration part

Example: 1

hashstringRequired

Configuration hash (changes with every setting update). Important: If hash = "0", the sensor runs deprecated software and cannot receive configuration updates.

Example: 1

Responses

401

Unauthorized.

HTTP to CoAP mapping: HTTP 401 or 403 will be converted to CoAP 4.01 UNAUTHORIZED.

403

Forbidden.

HTTP to CoAP mapping: HTTP 401 or 403 will be converted to CoAP 4.01 UNAUTHORIZED.

2XX

Success - Configuration data received successfully. Response body should be empty.

HTTP to CoAP mapping: Any 2xx HTTP status code (200, 201, 204, etc.) will be converted to CoAP 2.01 CREATED.

Note: This endpoint does NOT support returning configuration updates to the sensor. The sensor only sends configuration data and does not expect configuration in response.

application/json

3XX

Redirection.

HTTP to CoAP mapping: Any 3xx HTTP status code (301, 302, 304, etc.) will be converted to CoAP 5.00 INTERNAL SERVER ERROR.

4XX

Client Error.

HTTP to CoAP mapping: Any 4xx HTTP status code (except 401/403) will be converted to CoAP 4.00 BAD REQUEST.

5XX

Server Error.

HTTP to CoAP mapping: Any 5xx HTTP status code (500, 502, 503, etc.) will be converted to CoAP 5.00 INTERNAL SERVER ERROR.

post

/configuration

HTTPcURLJavaScriptPython

POST /configuration HTTP/1.1
charset: UTF-8
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "serialNumber": "282C024FFFB1",
  "timestamp": "1",
  "partsCount": 1,
  "partIndex": 1,
  "hash": "1",
  "parameters": [
    {
      "type": "ACK_INTERVAL",
      "settings": {
        "mode": "CUSTOM",
        "interval": "3600"
      }
    },
    {
      "type": "MEASUREMENT_PERIOD",
      "settings": {
        "period": "300"
      }
    },
    {
      "type": "TRANSMISSION_INTERVAL",
      "settings": {
        "interval": "900"
      }
    }
  ]
}

Basic sensor configurationConfiguration with server and endpointsConfiguration with custom APNConfiguration with high temperature threshold ruleConfiguration with multiple rule typesConfiguration with logic operator ruleConfiguration with rule calendarComplete sensor configuration example

No content