> For the complete documentation index, see [llms.txt](https://docs.efento.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.efento.io/nb-iot-loggers/integrations/efento-coap-loader/api-reference/configuration.md).
# Configuration
Endpoint for receiving sensor configuration updates
## Receive sensor configuration
> \## 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.
```json
{"openapi":"3.0.3","info":{"title":"CoAP Loader API Documentation","version":"3.0.0"},"tags":[{"name":"Configuration","description":"Endpoint for receiving sensor configuration updates"}],"paths":{"/configuration":{"post":{"tags":["Configuration"],"summary":"Receive sensor configuration","description":"## Overview\n\nThis endpoint is used to report the current configuration settings stored in the sensor's memory.\nThe CoAP Loader forwards this data to help you track and synchronize sensor settings with your platform.\n\n**Important:** The endpoint paths shown in this documentation (`/measurements`, `/configuration`, `/device-info`) are **examples only**.\n\nThe actual endpoint URLs are fully configurable in the CoAP Loader's `application.yml` file\n\n**When is it called?**\n- During the **first communication** after sensor boot/reset\n- Whenever a **configuration change is detected** on the device (hash value changes)\n- After you remotely update sensor settings via the `/measurements` response\n\n**What data do you receive?**\n- Complete snapshot of all current sensor settings\n- Configuration metadata: hash (version), timestamp, serialNumber\n- Information about configuration split (if payload is divided into multiple parts)\n\n**Use cases:**\n- Synchronize your database with actual sensor settings\n- Audit and track configuration changes over time\n- Verify that remote configuration updates were applied successfully\n\n## Request Structure\n\n**Method:** `POST`\n\n**Endpoint:** Configurable in `application.yml` under the `endpointConfiguration` key. The path `/configuration` shown here is just an example.\n\n**Headers:**\n- `Content-Type: application/json`\n- `charset: UTF-8`\n- `X-Api-Token: \"optional api token\"` (if configured on sensor via CLOUD_TOKEN parameter)\n\n**Body:** JSON object containing:\n- `serialNumber` - Unique sensor identifier\n- `timestamp` - Configuration timestamp\n- `hash` - Configuration version (changes with every update). **Important:** If hash = \"0\", the sensor runs deprecated software.\n- `partsCount` - Total number of configuration parts (for large configs)\n- `partIndex` - Current part index (1-based)\n- `parameters` - Array of configuration parameters. For detailed specification of all available parameter types, see **ConfigurationParametersReference** in the Models section.\n\n## Data Processing Notes\n\nThe CoAP Loader preprocesses the configuration data before forwarding:\n- **Duplicate parameters**: If the sensor sends duplicate parameter types, the CoAP Loader keeps only the **last occurrence** and logs a warning\n- **Invalid parameters**: Parameters that cannot be parsed are **automatically removed** and logged as errors - the remaining valid parameters are still forwarded to your API\n- **Partial data**: Even if some parameters fail to parse, you will receive all successfully parsed parameters\n\n## Response\n\nYour platform must respond with HTTP status code **2xx** (e.g., 200, 201, or 204) with an **empty body** to confirm receipt.\n\n**Note:** Unlike `/measurements`, this endpoint does NOT support returning configuration updates in the response.\n","operationId":"receiveSensorConfiguration","parameters":[{"name":"X-Api-Token","in":"header","description":"Optional API token for authentication (if configured)","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","default":"application/json"}},{"name":"charset","in":"header","required":true,"schema":{"type":"string","default":"UTF-8"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SensorConfiguration"}}}},"responses":{"401":{"description":"Unauthorized.\n\n**HTTP to CoAP mapping:** HTTP 401 or 403 will be converted to CoAP 4.01 UNAUTHORIZED.\n"},"403":{"description":"Forbidden.\n\n**HTTP to CoAP mapping:** HTTP 401 or 403 will be converted to CoAP 4.01 UNAUTHORIZED.\n"},"2XX":{"description":"Success - Configuration data received successfully.\nResponse body should be empty.\n\n**HTTP to CoAP mapping:** Any 2xx HTTP status code (200, 201, 204, etc.) will be converted to CoAP 2.01 CREATED.\n\n**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.\n","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"3XX":{"description":"Redirection.\n\n**HTTP to CoAP mapping:** Any 3xx HTTP status code (301, 302, 304, etc.) will be converted to CoAP 5.00 INTERNAL SERVER ERROR.\n"},"4XX":{"description":"Client Error.\n\n**HTTP to CoAP mapping:** Any 4xx HTTP status code (except 401/403) will be converted to CoAP 4.00 BAD REQUEST.\n"},"5XX":{"description":"Server Error.\n\n**HTTP to CoAP mapping:** Any 5xx HTTP status code (500, 502, 503, etc.) will be converted to CoAP 5.00 INTERNAL SERVER ERROR.\n"}}}}},"components":{"schemas":{"SensorConfiguration":{"type":"object","required":["serialNumber","timestamp","partsCount","partIndex","hash","parameters"],"properties":{"serialNumber":{"type":"string","description":"Unique serial number of the sensor"},"timestamp":{"type":"string","description":"Data timestamp"},"partsCount":{"type":"integer","description":"Total number of parts the configuration is divided into","minimum":1},"partIndex":{"type":"integer","description":"Index of the currently transmitted configuration part","minimum":1},"hash":{"type":"string","description":"Configuration hash (changes with every setting update).\n**Important:** If hash = \"0\", the sensor runs deprecated software and cannot receive configuration updates.\n"},"parameters":{"type":"array","description":"Current sensor settings. For detailed specification of all available parameter types and validation rules, see **ConfigurationParametersReference** in the Models section.\n\nMost commonly used types: MEASUREMENT_PERIOD, TRANSMISSION_INTERVAL, ACK_INTERVAL, SERVER_DATA, APN, PLMN, CLOUD_TOKEN, RULE_1-12, RULE_CALENDAR_1-6.\n","items":{"$ref":"#/components/schemas/SensorParameter"}}}},"SensorParameter":{"type":"object","required":["type","settings"],"properties":{"type":{"type":"string","description":"The unique name of the parameter. Available types include:\nACK_INTERVAL, APN, BANDS, BLE_TURNOFF_TIME, BLE_TX_POWER_LEVEL,\nCELLULAR_CONFIG, CLOUD_TOKEN, CLOUD_TOKEN_COAP_OPTION,\nCONFIGURATION_ENDPOINT, DATA_ENDPOINT, DEVICE_INFO_ENDPOINT,\nDNS_SERVER, DNS_TTL_CONFIG, ENCRYPTION_KEY, LED_CONFIG,\nMEASUREMENT_PERIOD, NETWORK_TROUBLESHOOTING,\nPAYLOAD_SIGNATURE_COAP_OPTION, PLMN, REQUEST_DISABLE_MODEM,\nSERVER_DATA, SERVER_UPDATE, SUPERVISION_PERIOD, TIME_ENDPOINT,\nTRANSMISSION_INTERVAL, TRANSFER_LIMIT, TRANSFER_LIMIT_TIMER,\nCALIBRATION, RULE_1 through RULE_12, RULE_CALENDAR_1 through RULE_CALENDAR_6\n\nFor detailed specification of each parameter type, including required fields and validation rules, see **ConfigurationParametersReference** in the Models section.\n"},"settings":{"type":"object","description":"A nested object containing specific key-value pairs for that parameter","additionalProperties":true}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.efento.io/nb-iot-loggers/integrations/efento-coap-loader/api-reference/configuration.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.