{ "info": { "_postman_id": "fefda51e-164b-4263-a25f-ba8ac466f5e0", "name": "ThingsBoard Admin admin-controller device-controller API", "description": "ThingsBoard Admin API \u2014 subset of the ThingsBoard REST API (open-source IoT platform). Covers: Admin, Audit Log, Event, Usage Info, Queue, Queue Stats, Mail Config Template, Qr Code Settings, Job.\n\nContact Support:\n Name: ThingsBoard team\n Email: info@thingsboard.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-fefda51e-164b-4263-a25f-ba8ac466f5e0" }, "item": [ { "name": "api", "item": [ { "name": "tenant", "item": [ { "name": "{tenantId}", "item": [ { "name": "device", "item": [ { "name": "{deviceId}", "item": [ { "name": "Assign Device to Tenant (assignDeviceToTenant)", "id": "8104483f-19e3-433e-9129-bda20d3ba919", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/:tenantId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", ":tenantId", "device", ":deviceId" ], "variable": [ { "id": "be56eb8f-308b-45d3-9fd4-244a6acb2de9", "key": "tenantId", "value": "", "description": "(Required) A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "1a8dd8f2-11ef-4f02-9b19-b273f0cbee55", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Creates assignment of the device to tenant. Thereafter tenant will be able to reassign the device to a customer.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "cfe23137-7b81-4646-a9c9-ab17495de486", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/:tenantId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", ":tenantId", "device", ":deviceId" ], "variable": [ { "key": "tenantId" }, { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-cfe23137-7b81-4646-a9c9-ab17495de486" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-8104483f-19e3-433e-9129-bda20d3ba919" } ], "id": "865b5819-f6db-40ce-b2c0-6d548f5d2290", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-865b5819-f6db-40ce-b2c0-6d548f5d2290" } ], "id": "c60afa45-fdf2-4edf-be72-2b0275299431", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-c60afa45-fdf2-4edf-be72-2b0275299431" } ], "id": "54feb409-480d-4db7-9082-57bea3348dde", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-54feb409-480d-4db7-9082-57bea3348dde" }, { "name": "devices", "item": [ { "name": "Get Tenant Device (getTenantDevice)", "id": "7769824e-f4d9-4675-aa3e-568c0433ab4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/devices?pageSize=&page=&type=&textSearch=&sortProperty=label&sortOrder=DESC&deviceName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "devices" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" }, { "description": "(Required) A string value representing the Device name.", "key": "deviceName", "value": "" } ] }, "description": "Requested device must be owned by tenant that the user belongs to. Device name is an unique property of device. So it can be used to identify the device.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "51f50538-8ced-49c2-b7f4-4aef9e997f7b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/devices?pageSize=&page=&type=&textSearch=&sortProperty=label&sortOrder=DESC&deviceName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "devices" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" }, { "description": "(Required) A string value representing the Device name.", "key": "deviceName", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-51f50538-8ced-49c2-b7f4-4aef9e997f7b" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-7769824e-f4d9-4675-aa3e-568c0433ab4d" } ], "id": "3d47b881-31f6-4b77-b28c-240d0ee5a602", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3d47b881-31f6-4b77-b28c-240d0ee5a602" }, { "name": "deviceInfos", "item": [ { "name": "Get Tenant Device Infos (getTenantDeviceInfos)", "id": "a16ecb01-09d3-485a-9c6f-3705f020b32f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/deviceInfos?pageSize=&page=&type=&deviceProfileId=&active=&textSearch=&sortProperty=label&sortOrder=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "deviceInfos" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'", "key": "deviceProfileId", "value": "" }, { "description": "A boolean value representing the device active flag.", "key": "active", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" } ] }, "description": "Returns a page of devices info objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. \n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "d51b83ba-9148-4e75-b5df-448d6671e8ba", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/tenant/deviceInfos?pageSize=&page=&type=&deviceProfileId=&active=&textSearch=&sortProperty=label&sortOrder=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "tenant", "deviceInfos" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'", "key": "deviceProfileId", "value": "" }, { "description": "A boolean value representing the device active flag.", "key": "active", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n },\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"PSM\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-d51b83ba-9148-4e75-b5df-448d6671e8ba" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-a16ecb01-09d3-485a-9c6f-3705f020b32f" } ], "id": "0aafdfc7-e412-44d9-86ad-a487d8ad420a", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-0aafdfc7-e412-44d9-86ad-a487d8ad420a" } ], "id": "3ef2fa2f-2fae-4e99-8b1e-6cf99c37faaf", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3ef2fa2f-2fae-4e99-8b1e-6cf99c37faaf" }, { "name": "edge", "item": [ { "name": "{edgeId}", "item": [ { "name": "device", "item": [ { "name": "{deviceId}", "item": [ { "name": "Assign Device to Edge (assignDeviceToEdge)", "id": "c4f34c80-a857-45db-8500-584714529d4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "device", ":deviceId" ], "variable": [ { "id": "02e8bede-7cc7-4b04-ad52-ad1782957f86", "key": "edgeId", "value": "", "description": "(Required) A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "2e764f11-46c8-43ed-8759-47fcf3f4d320", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Creates assignment of an existing device to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment device (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once device will be delivered to edge service, it's going to be available for usage on remote edge instance.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "3e61b7de-f2ee-475b-974a-88776339eadb", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "device", ":deviceId" ], "variable": [ { "key": "edgeId" }, { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3e61b7de-f2ee-475b-974a-88776339eadb" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-c4f34c80-a857-45db-8500-584714529d4c" }, { "name": "Unassign Device from Edge (unassignDeviceFromEdge)", "id": "7c14217e-2b6d-4610-8e84-81fa148c6185", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "device", ":deviceId" ], "variable": [ { "id": "221b24fa-dab8-4f08-b986-11547692e8b8", "key": "edgeId", "value": "", "description": "(Required) A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "ef100993-cce9-4b77-83b9-876cda98aaa5", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Clears assignment of the device to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove device (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove device locally.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "5d60b533-7a7d-4c9a-8da0-c76c5b930076", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "device", ":deviceId" ], "variable": [ { "key": "edgeId" }, { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-5d60b533-7a7d-4c9a-8da0-c76c5b930076" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-7c14217e-2b6d-4610-8e84-81fa148c6185" } ], "id": "71369c78-1d4b-4c33-a9f9-ef92fe8709f3", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-71369c78-1d4b-4c33-a9f9-ef92fe8709f3" } ], "id": "cf3eb673-a88e-4483-93ce-0df7704330b6", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-cf3eb673-a88e-4483-93ce-0df7704330b6" }, { "name": "devices", "item": [ { "name": "Get Devices Assigned to Edge (getEdgeDevices)", "id": "92b4c341-796c-482d-b36b-7a135d810372", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/devices?pageSize=&page=&type=&deviceProfileId=&active=&textSearch=&sortProperty=label&sortOrder=DESC&startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "devices" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'", "key": "deviceProfileId", "value": "" }, { "description": "A boolean value representing the device active flag.", "key": "active", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" }, { "description": "Timestamp. Devices with creation time before it won't be queried", "key": "startTime", "value": "" }, { "description": "Timestamp. Devices with creation time after it won't be queried", "key": "endTime", "value": "" } ], "variable": [ { "id": "fc6900f0-141e-4c7d-9a14-00df54ebe1e4", "key": "edgeId", "value": "", "description": "(Required) A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of devices assigned to edge. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "2a451fa2-2a16-4ebc-a95f-9350d434082e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/edge/:edgeId/devices?pageSize=&page=&type=&deviceProfileId=&active=&textSearch=&sortProperty=label&sortOrder=DESC&startTime=&endTime=", "host": [ "{{baseUrl}}" ], "path": [ "api", "edge", ":edgeId", "devices" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'", "key": "deviceProfileId", "value": "" }, { "description": "A boolean value representing the device active flag.", "key": "active", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" }, { "description": "Timestamp. Devices with creation time before it won't be queried", "key": "startTime", "value": "" }, { "description": "Timestamp. Devices with creation time after it won't be queried", "key": "endTime", "value": "" } ], "variable": [ { "key": "edgeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n },\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"PSM\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-2a451fa2-2a16-4ebc-a95f-9350d434082e" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-92b4c341-796c-482d-b36b-7a135d810372" } ], "id": "089dc02e-1e55-4fdc-a6f5-78a2f0bd5ad9", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-089dc02e-1e55-4fdc-a6f5-78a2f0bd5ad9" } ], "id": "e5fd82bc-2798-4a16-a19b-8976884c21d3", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-e5fd82bc-2798-4a16-a19b-8976884c21d3" } ], "id": "c52bcb52-7f00-4303-8aea-42057221036e", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-c52bcb52-7f00-4303-8aea-42057221036e" }, { "name": "devices", "item": [ { "name": "count", "item": [ { "name": "{otaPackageType}", "item": [ { "name": "{deviceProfileId}", "item": [ { "name": "Count Devices by Device Profile (countByDeviceProfileAndEmptyOtaPackage)", "id": "9f4b81c9-e100-4410-82ab-ad0b4fe9cf5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/devices/count/:otaPackageType/:deviceProfileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices", "count", ":otaPackageType", ":deviceProfileId" ], "variable": [ { "id": "33420023-30a9-4cf9-aa06-71cf61f99559", "key": "otaPackageType", "value": "SOFTWARE", "description": "(Required) OTA package type" }, { "id": "b539a78c-971b-4f91-b799-3729d1bc5d83", "key": "deviceProfileId", "value": "", "description": "(Required) Device Profile Id. I.g. '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "The platform gives an ability to load OTA (over-the-air) packages to devices. It can be done in two different ways: device scope or device profile scope.In the response you will find the number of devices with specified device profile, but without previously defined device scope OTA package. It can be useful when you want to define number of devices that will be affected with future OTA package\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "1966695f-da65-46c1-bf96-1ffeb2f12951", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/devices/count/:otaPackageType/:deviceProfileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices", "count", ":otaPackageType", ":deviceProfileId" ], "variable": [ { "key": "otaPackageType" }, { "key": "deviceProfileId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-1966695f-da65-46c1-bf96-1ffeb2f12951" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-9f4b81c9-e100-4410-82ab-ad0b4fe9cf5c" } ], "id": "91043b5d-cd3d-4cef-a7e1-5eb66958a622", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-91043b5d-cd3d-4cef-a7e1-5eb66958a622" } ], "id": "f7c49144-0526-4107-ae3c-38913972b5d8", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-f7c49144-0526-4107-ae3c-38913972b5d8" } ], "id": "3d11ca35-3fbe-47c1-b472-586535172f22", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3d11ca35-3fbe-47c1-b472-586535172f22" }, { "name": "Get Devices by Ids (getDevicesByIds)", "id": "fa84a05a-78ac-49f9-a98a-cfed424229f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/devices?deviceIds=&deviceIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices" ], "query": [ { "description": "(Required) A list of devices ids, separated by comma ','", "key": "deviceIds", "value": "" }, { "description": "(Required) A list of devices ids, separated by comma ','", "key": "deviceIds", "value": "" } ] }, "description": "Requested devices must be owned by tenant or assigned to customer which user is performing the request. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "8469d91c-73e2-4ffa-9fc1-c550569b54a6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/devices?deviceIds=", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices" ], "query": [ { "description": "(Required) A list of devices ids, separated by comma ','", "key": "deviceIds", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n },\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"PSM\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n]", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-8469d91c-73e2-4ffa-9fc1-c550569b54a6" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-fa84a05a-78ac-49f9-a98a-cfed424229f7" }, { "name": "Find Related Devices (findByQuery)", "id": "30fa1359-6494-4696-84ae-3d2482ec4021", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"rootId\": \"\",\n \"rootType\": \"ASSET\",\n \"direction\": \"TO\",\n \"relationTypeGroup\": \"RULE_NODE\",\n \"maxLevel\": \"\",\n \"fetchLastLevelOnly\": \"\"\n },\n \"relationType\": \"\",\n \"deviceTypes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/devices", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices" ] }, "description": "Returns all devices that are related to the specific entity. The entity id, relation type, device types, depth of the search, and other query parameters defined using complex 'DeviceSearchQuery' object. See 'Model' tab of the Parameters for more info.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "f92ca35c-dd9e-4fe1-8308-8db9ba01b84a", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": {\n \"rootId\": \"\",\n \"rootType\": \"ASSET\",\n \"direction\": \"TO\",\n \"relationTypeGroup\": \"RULE_NODE\",\n \"maxLevel\": \"\",\n \"fetchLastLevelOnly\": \"\"\n },\n \"relationType\": \"\",\n \"deviceTypes\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/devices", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n },\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"PSM\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n]", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-f92ca35c-dd9e-4fe1-8308-8db9ba01b84a" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-30fa1359-6494-4696-84ae-3d2482ec4021" } ], "id": "4cdf4b52-1fe3-4463-995f-763847b5dc5f", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-4cdf4b52-1fe3-4463-995f-763847b5dc5f" }, { "name": "device", "item": [ { "name": "credentials", "item": [ { "name": "Update Device Credentials (updateDeviceCredentials)", "id": "726b7942-890e-4813-9405-12076ad734f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credentialsId\": \"\",\n \"deviceId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"credentialsType\": \"MQTT_BASIC\",\n \"credentialsValue\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device/credentials", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "credentials" ] }, "description": "During device creation, platform generates random 'ACCESS_TOKEN' credentials. \" +\nUse this method to update the device credentials. First use 'getDeviceCredentialsByDeviceId' to get the credentials id and value.\nThen use current method to update the credentials type and value. It is not possible to create multiple device credentials for the same device.\nThe structure of device credentials id and value is simple for the 'ACCESS_TOKEN' but is much more complex for the 'MQTT_BASIC' or 'LWM2M_CREDENTIALS'.\nYou may find the example of device with different type of credentials below: \n\n- Credentials type: \"Access token\" with device ID and with device ID below: \n\n```json\n{\n \"id\": {\n \"id\":\"c886a090-168d-11ee-87c9-6f157dbc816a\"\n },\n \"deviceId\": {\n \"id\":\"c5fb3ac0-168d-11ee-87c9-6f157dbc816a\",\n \"entityType\":\"DEVICE\"\n },\n \"credentialsType\": \"ACCESS_TOKEN\",\n \"credentialsId\": \"6hmxew8pmmzng4e3une4\"\n}\n```\n\n- Credentials type: \"X509\" with device profile ID below: \n\nNote: credentialsId - format Sha3Hash, certificateValue - format PEM (with \"--BEGIN CERTIFICATE----\" and -\"----END CERTIFICATE-\").\n\n```json\n{\n \"id\": {\n \"id\":\"309bd9c0-14f4-11ee-9fc9-d9b7463abb63\"\n },\n \"deviceId\": {\n \"id\":\"3092b200-14f4-11ee-9fc9-d9b7463abb63\",\n \"entityType\":\"DEVICE\"\n },\n \"credentialsType\": \"X509_CERTIFICATE\",\n \"credentialsId\": \"6b8adb49015500e51a527acd332b51684ab9b49b4ade03a9582a44c455e2e9b6\",\n \"credentialsValue\": \"-----BEGIN CERTIFICATE----- MIICMTCCAdegAwIBAgIUUEKxS9hTz4l+oLUMF0LV6TC/gCIwCgYIKoZIzj0EAwIwbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlUHJvZmlsZUNlcnRAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MB4XDTIzMDMyOTE0NTczNloXDTI0MDMyODE0NTczNlowbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlUHJvZmlsZUNlcnRAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAECMlWO72krDoUL9FQjUmSCetkhaEGJUfQkdSfkLSNa0GyAEIMbfmzI4zITeapunu4rGet3EMyLydQzuQanBicp6NTMFEwHQYDVR0OBBYEFHpZ78tPnztNii4Da/yCw6mhEIL3MB8GA1UdIwQYMBaAFHpZ78tPnztNii4Da/yCw6mhEIL3MA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDSAAwRQIgJ7qyMFqNcwSYkH6o+UlQXzLWfwZbNjVk+aR7foAZNGsCIQDsd7v3WQIGHiArfZeDs1DLEDuV/2h6L+ZNoGNhEKL+1A== -----END CERTIFICATE-----\"\n}\n```\n\n- Credentials type: \"MQTT_BASIC\" with device profile ID below: \n\n```json\n{\n \"id\": {\n \"id\":\"d877ffb0-14f5-11ee-9fc9-d9b7463abb63\"\n },\n \"deviceId\": {\n \"id\":\"d875dcd0-14f5-11ee-9fc9-d9b7463abb63\",\n \"entityType\":\"DEVICE\"\n },\n \"credentialsType\": \"MQTT_BASIC\",\n \"credentialsValue\": \"{\\\"clientId\\\":\\\"juy03yv4owqxcmqhqtvk\\\",\\\"userName\\\":\\\"ov19fxca0cyjn7lm7w7u\\\",\\\"password\\\":\\\"twy94he114dfi9usyk1o\\\"}\"\n}\n```\n\n- You may find the example of LwM2M device and RPK credentials below: \n\nNote: LwM2M device - only existing device profile ID (Transport configuration -> Transport type: \"LWM2M\".\n\n```json\n{\n \"id\": {\n \"id\":\"e238d4d0-1689-11ee-98c6-1713c1be5a8e\"\n },\n \"deviceId\": {\n \"id\":\"e232e160-1689-11ee-98c6-1713c1be5a8e\",\n \"entityType\":\"DEVICE\"\n },\n \"credentialsType\": \"LWM2M_CREDENTIALS\",\n \"credentialsId\": \"LwRpk00000000\",\n \"credentialsValue\":\n \"{\\\"client\\\":{ \\\"endpoint\\\":\\\"LwRpk00000000\\\", \\\"securityConfigClientMode\\\":\\\"RPK\\\", \\\"key\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdvBZZ2vQRK9wgDhctj6B1c7bxR3Z0wYg1+YdoYFnVUKWb+rIfTTyYK9tmQJx5Vlb5fxdLnVv1RJOPiwsLIQbAA==\\\" }, \\\"bootstrap\\\":{ \\\"bootstrapServer\\\":{ \\\"securityMode\\\":\\\"RPK\\\", \\\"clientPublicKeyOrId\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\\\", \\\"clientSecretKey\\\":\\\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\\\"}, \\\"lwm2mServer\\\":{ \\\"securityMode\\\":\\\"RPK\\\", \\\"clientPublicKeyOrId\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\\\", \\\"clientSecretKey\\\":\\\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\\\"}} }\"\n}\n```\n\nUpdate to real value:\n - 'id' (this is id of Device Credentials -> \"Get Device Credentials (getDeviceCredentialsByDeviceId)\",\n - 'deviceId.id' (this is id of Device).\nRemove 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "0cc3e382-d2b3-42ef-8319-83cdce322b41", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credentialsId\": \"\",\n \"deviceId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"credentialsType\": \"MQTT_BASIC\",\n \"credentialsValue\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device/credentials", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "credentials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentialsId\": \"\",\n \"deviceId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"credentialsType\": \"MQTT_BASIC\",\n \"credentialsValue\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-0cc3e382-d2b3-42ef-8319-83cdce322b41" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-726b7942-890e-4813-9405-12076ad734f3" } ], "id": "75c228fe-9b65-402c-bc9e-81063a26a2d6", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-75c228fe-9b65-402c-bc9e-81063a26a2d6" }, { "name": "bulk_import", "item": [ { "name": "Import the Bulk of Devices (processDevicesBulkImport)", "id": "44ce3602-7642-4c0e-9d0a-9b3aa4daa8a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mapping\": {\n \"columns\": [\n {\n \"type\": \"NAME\",\n \"key\": \"\"\n },\n {\n \"type\": \"X509\",\n \"key\": \"\"\n }\n ],\n \"delimiter\": \"\",\n \"update\": \"\",\n \"header\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device/bulk_import", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "bulk_import" ] }, "description": "There's an ability to import the bulk of devices using the only .csv file.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "3a94c05e-0bf1-4adf-bb6c-4a327c5c8f06", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"mapping\": {\n \"columns\": [\n {\n \"type\": \"NAME\",\n \"key\": \"\"\n },\n {\n \"type\": \"X509\",\n \"key\": \"\"\n }\n ],\n \"delimiter\": \"\",\n \"update\": \"\",\n \"header\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device/bulk_import", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "bulk_import" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"updated\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"errors\": {\n \"opaque\": \"\",\n \"acquire\": \"\",\n \"release\": \"\",\n \"andIncrement\": \"\",\n \"andDecrement\": \"\",\n \"plain\": \"\"\n },\n \"errorsList\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3a94c05e-0bf1-4adf-bb6c-4a327c5c8f06" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-44ce3602-7642-4c0e-9d0a-9b3aa4daa8a2" } ], "id": "ff286e5a-0468-497e-ba86-7773927bbc7e", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-ff286e5a-0468-497e-ba86-7773927bbc7e" }, { "name": "{deviceId}", "item": [ { "name": "credentials", "item": [ { "name": "Get Device Credentials (getDeviceCredentialsByDeviceId)", "id": "5a89eceb-b8ab-4809-895b-0385b94f2989", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/:deviceId/credentials", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", ":deviceId", "credentials" ], "variable": [ { "id": "32d4df91-e145-419b-a043-4766bab3a17f", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "If during device creation there wasn't specified any credentials, platform generates random 'ACCESS_TOKEN' credentials.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "51cd4897-9412-48b5-8055-fb824e818454", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/:deviceId/credentials", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", ":deviceId", "credentials" ], "variable": [ { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"credentialsId\": \"\",\n \"deviceId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"credentialsType\": \"MQTT_BASIC\",\n \"credentialsValue\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-51cd4897-9412-48b5-8055-fb824e818454" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-5a89eceb-b8ab-4809-895b-0385b94f2989" } ], "id": "85db80ec-c19a-401f-893a-1f8f3a2ce074", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-85db80ec-c19a-401f-893a-1f8f3a2ce074" }, { "name": "Get Device (getDeviceById)", "id": "111dbdfd-1da5-4561-8060-f4fdababd31c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", ":deviceId" ], "variable": [ { "id": "b4db5bbb-69f9-4d55-aceb-4355d91d6e3c", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Fetch the Device object based on the provided Device Id. If the user has the authority of 'TENANT_ADMIN', the server checks that the device is owned by the same tenant. If the user has the authority of 'CUSTOMER_USER', the server checks that the device is assigned to the same customer.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "972e9f25-3b0b-4e34-9b36-e90c30777962", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", ":deviceId" ], "variable": [ { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-972e9f25-3b0b-4e34-9b36-e90c30777962" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-111dbdfd-1da5-4561-8060-f4fdababd31c" }, { "name": "Delete Device (deleteDevice)", "id": "9166cbfc-8533-43c7-a11a-fd1f3a11c7bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", ":deviceId" ], "variable": [ { "id": "a60531ed-03f9-4516-a69f-98a8aa36937c", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Deletes the device, it's credentials and all the relations (from and to the device). Referencing non-existing device Id will cause an error.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "f9a9e8b1-f6fb-4baa-b6ef-26a5cf28580b", "name": "OK", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", ":deviceId" ], "variable": [ { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-f9a9e8b1-f6fb-4baa-b6ef-26a5cf28580b" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-9166cbfc-8533-43c7-a11a-fd1f3a11c7bf" } ], "id": "00f1f405-4c3a-4d08-87ff-1b3d857c7101", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-00f1f405-4c3a-4d08-87ff-1b3d857c7101" }, { "name": "types", "item": [ { "name": "Get Device Types (getDeviceTypes)", "id": "1a40812c-2f07-429f-ba94-46b78b9f6de2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/types", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "types" ] }, "description": "Deprecated. See 'getDeviceProfileNames' API from Device Profile Controller instead.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "2e4e83cf-0d68-4c9c-98b0-4ca9f7127306", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/types", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"entityType\": \"AI_MODEL\",\n \"type\": \"\"\n },\n {\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"entityType\": \"NOTIFICATION_TEMPLATE\",\n \"type\": \"\"\n }\n]", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-2e4e83cf-0d68-4c9c-98b0-4ca9f7127306" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-1a40812c-2f07-429f-ba94-46b78b9f6de2" } ], "id": "3b85879c-0916-4543-a2cc-4b777afe78de", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3b85879c-0916-4543-a2cc-4b777afe78de" }, { "name": "info", "item": [ { "name": "{deviceId}", "item": [ { "name": "Get Device Info (getDeviceInfoById)", "id": "44394a6a-928a-49d4-9fe2-6265b568db14", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/info/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "info", ":deviceId" ], "variable": [ { "id": "93d481ed-447c-4968-84f7-4176e86463c1", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Fetch the Device Info object based on the provided Device Id. If the user has the authority of 'Tenant Administrator', the server checks that the device is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the device is assigned to the same customer. Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "69c127aa-d49f-480e-a761-5d53193e6c2b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/device/info/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "device", "info", ":deviceId" ], "variable": [ { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-69c127aa-d49f-480e-a761-5d53193e6c2b" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-44394a6a-928a-49d4-9fe2-6265b568db14" } ], "id": "9843928b-729f-471e-8cfe-15eed1efb6b0", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-9843928b-729f-471e-8cfe-15eed1efb6b0" } ], "id": "af4e6777-e2af-4405-bbad-ee963547e5ef", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-af4e6777-e2af-4405-bbad-ee963547e5ef" }, { "name": "Create or Update Device (saveDevice)", "id": "8fe57375-9f52-4f95-8512-151fc122f3c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device?accessToken=&nameConflictPolicy=FAIL&uniquifySeparator=_&uniquifyStrategy=RANDOM", "host": [ "{{baseUrl}}" ], "path": [ "api", "device" ], "query": [ { "description": "Optional value of the device credentials to be used during device creation. If omitted, access token will be auto-generated.", "key": "accessToken", "value": "" }, { "description": "Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.", "key": "nameConflictPolicy", "value": "FAIL" }, { "description": "Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.", "key": "uniquifySeparator", "value": "_" }, { "description": "Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.", "key": "uniquifyStrategy", "value": "RANDOM" } ] }, "description": "Create or update the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). Device credentials are also generated if not provided in the 'accessToken' request parameter. The newly created device id will be present in the response. Specify existing Device id to update the device. Referencing non-existing device Id will cause 'Not Found' error.\n\nDevice name is unique in the scope of tenant. Use unique identifiers like MAC or IMEI for the device names and non-unique 'label' field for user-friendly visualization purposes.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "3a1c0d0e-2971-42bd-acad-0d339d5a79fb", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device?accessToken=&nameConflictPolicy=FAIL&uniquifySeparator=_&uniquifyStrategy=RANDOM", "host": [ "{{baseUrl}}" ], "path": [ "api", "device" ], "query": [ { "description": "Optional value of the device credentials to be used during device creation. If omitted, access token will be auto-generated.", "key": "accessToken", "value": "" }, { "description": "Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.", "key": "nameConflictPolicy", "value": "FAIL" }, { "description": "Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.", "key": "uniquifySeparator", "value": "_" }, { "description": "Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.", "key": "uniquifyStrategy", "value": "RANDOM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-3a1c0d0e-2971-42bd-acad-0d339d5a79fb" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-8fe57375-9f52-4f95-8512-151fc122f3c2" } ], "id": "242c501d-a23b-4d14-ac37-8f76f4fe4f76", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-242c501d-a23b-4d14-ac37-8f76f4fe4f76" }, { "name": "device-with-credentials", "item": [ { "name": "Create Device (saveDevice) with Credentials", "id": "11f38db9-05e8-46c5-8db8-7eb23a952ad0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"credentialsId\": \"\",\n \"deviceId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"credentialsType\": \"LWM2M_CREDENTIALS\",\n \"credentialsValue\": \"\",\n \"version\": \"\"\n },\n \"device\": {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device-with-credentials?nameConflictPolicy=FAIL&uniquifySeparator=_&uniquifyStrategy=RANDOM", "host": [ "{{baseUrl}}" ], "path": [ "api", "device-with-credentials" ], "query": [ { "description": "Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.", "key": "nameConflictPolicy", "value": "FAIL" }, { "description": "Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.", "key": "uniquifySeparator", "value": "_" }, { "description": "Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.", "key": "uniquifyStrategy", "value": "RANDOM" } ] }, "description": "Create or update the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). Requires to provide the Device Credentials object as well as an existing device profile ID or use \"default\".\nYou may find the example of device with different type of credentials below: \n\n- Credentials type: \"Access token\" with device profile ID below: \n\n```json\n{\n \"device\": {\n \"name\":\"Name_DeviceWithCredantial_AccessToken\",\n \"label\":\"Label_DeviceWithCredantial_AccessToken\",\n \"deviceProfileId\":{\n \"id\":\"9d9588c0-06c9-11ee-b618-19be30fdeb60\",\n \"entityType\":\"DEVICE_PROFILE\"\n }\n },\n \"credentials\": {\n \"credentialsType\": \"ACCESS_TOKEN\",\n \"credentialsId\": \"6hmxew8pmmzng4e3une2\"\n }\n}\n```\n\n- Credentials type: \"Access token\" with device profile default below: \n\n```json\n{\n \"device\": {\n \"name\":\"Name_DeviceWithCredantial_AccessToken_Default\",\n \"label\":\"Label_DeviceWithCredantial_AccessToken_Default\",\n \"type\": \"default\"\n },\n \"credentials\": {\n \"credentialsType\": \"ACCESS_TOKEN\",\n \"credentialsId\": \"6hmxew8pmmzng4e3une3\"\n }\n}\n```\n\n- Credentials type: \"X509\" with device profile ID below: \n\nNote: credentialsId - format Sha3Hash, certificateValue - format PEM (with \"--BEGIN CERTIFICATE----\" and -\"----END CERTIFICATE-\").\n\n```json\n{\n \"device\": {\n \"name\":\"Name_DeviceWithCredantial_X509_Certificate\",\n \"label\":\"Label_DeviceWithCredantial_X509_Certificate\",\n \"deviceProfileId\":{\n \"id\":\"9d9588c0-06c9-11ee-b618-19be30fdeb60\",\n \"entityType\":\"DEVICE_PROFILE\"\n }\n },\n \"credentials\": {\n \"credentialsType\": \"X509_CERTIFICATE\",\n \"credentialsId\": \"84f5911765abba1f96bf4165604e9e90338fc6214081a8e623b6ff9669aedb27\",\n \"credentialsValue\": \"-----BEGIN CERTIFICATE----- MIICMTCCAdegAwIBAgIUI9dBuwN6pTtK6uZ03rkiCwV4wEYwCgYIKoZIzj0EAwIwbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlQ2VydGlmaWNhdGVAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MB4XDTIzMDMyOTE0NTYxN1oXDTI0MDMyODE0NTYxN1owbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlQ2VydGlmaWNhdGVAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE9Zo791qKQiGNBm11r4ZGxh+w+ossZL3xc46ufq5QckQHP7zkD2XDAcmP5GvdkM1sBFN9AWaCkQfNnWmfERsOOKNTMFEwHQYDVR0OBBYEFFFc5uyCyglQoZiKhzXzMcQ3BKORMB8GA1UdIwQYMBaAFFFc5uyCyglQoZiKhzXzMcQ3BKORMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDSAAwRQIhANbA9CuhoOifZMMmqkpuld+65CR+ItKdXeRAhLMZuccuAiB0FSQB34zMutXrZj1g8Gl5OkE7YryFHbei1z0SveHR8g== -----END CERTIFICATE-----\"\n }\n}\n```\n\n- Credentials type: \"MQTT_BASIC\" with device profile ID below: \n\n```json\n{\n \"device\": {\n \"name\":\"Name_DeviceWithCredantial_MQTT_Basic\",\n \"label\":\"Label_DeviceWithCredantial_MQTT_Basic\",\n \"deviceProfileId\":{\n \"id\":\"9d9588c0-06c9-11ee-b618-19be30fdeb60\",\n \"entityType\":\"DEVICE_PROFILE\"\n }\n },\n \"credentials\": {\n \"credentialsType\": \"MQTT_BASIC\",\n \"credentialsValue\": \"{\\\"clientId\\\":\\\"5euh5nzm34bjjh1efmlt\\\",\\\"userName\\\":\\\"onasd1lgwasmjl7v2v7h\\\",\\\"password\\\":\\\"b9xtm4ny8kt9zewaga5o\\\"}\"\n }\n}\n```\n\n- You may find the example of LwM2M device and RPK credentials below: \n\nNote: LwM2M device - only existing device profile ID (Transport configuration -> Transport type: \"LWM2M\".\n\n```json\n{\n \"device\": {\n \"name\":\"Name_LwRpk00000000\",\n \"label\":\"Label_LwRpk00000000\",\n \"deviceProfileId\":{\n \"id\":\"a660bd50-10ef-11ee-8737-b5634e73c779\",\n \"entityType\":\"DEVICE_PROFILE\"\n }\n },\n \"credentials\": {\n \"credentialsType\": \"LWM2M_CREDENTIALS\",\n \"credentialsId\": \"LwRpk00000000\",\n \"credentialsValue\":\n \"{\\\"client\\\":{ \\\"endpoint\\\":\\\"LwRpk00000000\\\", \\\"securityConfigClientMode\\\":\\\"RPK\\\", \\\"key\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\\\" }, \\\"bootstrap\\\":{ \\\"bootstrapServer\\\":{ \\\"securityMode\\\":\\\"RPK\\\", \\\"clientPublicKeyOrId\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\\\", \\\"clientSecretKey\\\":\\\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\\\"}, \\\"lwm2mServer\\\":{ \\\"securityMode\\\":\\\"RPK\\\", \\\"clientPublicKeyOrId\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\\\", \\\"clientSecretKey\\\":\\\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\\\"}} }\"\n }\n}\n```\n\nRemove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "4fda4a1a-ff43-4254-97a2-d36071de350f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"credentialsId\": \"\",\n \"deviceId\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"id\": {\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"credentialsType\": \"LWM2M_CREDENTIALS\",\n \"credentialsValue\": \"\",\n \"version\": \"\"\n },\n \"device\": {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/device-with-credentials?nameConflictPolicy=FAIL&uniquifySeparator=_&uniquifyStrategy=RANDOM", "host": [ "{{baseUrl}}" ], "path": [ "api", "device-with-credentials" ], "query": [ { "description": "Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.", "key": "nameConflictPolicy", "value": "FAIL" }, { "description": "Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.", "key": "uniquifySeparator", "value": "_" }, { "description": "Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.", "key": "uniquifyStrategy", "value": "RANDOM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-4fda4a1a-ff43-4254-97a2-d36071de350f" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-11f38db9-05e8-46c5-8db8-7eb23a952ad0" } ], "id": "abd543de-59c4-4b60-a2bc-ff6f2558d652", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-abd543de-59c4-4b60-a2bc-ff6f2558d652" }, { "name": "customer", "item": [ { "name": "{customerId}", "item": [ { "name": "device", "item": [ { "name": "{deviceId}", "item": [ { "name": "Assign Device to Customer (assignDeviceToCustomer)", "id": "e1148bfc-aa43-4b30-84bb-62960a08934a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "device", ":deviceId" ], "variable": [ { "id": "c1378cad-350e-4881-999a-407e9d7b4641", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "id": "122c83f2-f197-411e-a913-ac0e92791945", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Creates assignment of the device to customer. Customer will be able to query device afterwards.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "016cb4c7-4d69-40c6-aa58-fe200baa310b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "device", ":deviceId" ], "variable": [ { "key": "customerId" }, { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-016cb4c7-4d69-40c6-aa58-fe200baa310b" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-e1148bfc-aa43-4b30-84bb-62960a08934a" } ], "id": "68f42552-f1d5-4716-97dd-82778f69191a", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-68f42552-f1d5-4716-97dd-82778f69191a" } ], "id": "870b8b71-d28c-42c6-a5bc-3f920f6730da", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-870b8b71-d28c-42c6-a5bc-3f920f6730da" }, { "name": "devices", "item": [ { "name": "Get Customer Devices (getCustomerDevices)", "id": "0e476bb4-80d0-4185-b23d-b6b322298a7e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/devices?pageSize=&page=&type=&textSearch=&sortProperty=label&sortOrder=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "devices" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" } ], "variable": [ { "id": "74495c09-5687-4881-a36d-7c7f6ebe8dd2", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of devices objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "b09c2df2-f07d-4f36-9e4e-4f67d67603c8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/devices?pageSize=&page=&type=&textSearch=&sortProperty=label&sortOrder=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "devices" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n },\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"PSM\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-b09c2df2-f07d-4f36-9e4e-4f67d67603c8" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-0e476bb4-80d0-4185-b23d-b6b322298a7e" } ], "id": "5f66a2fc-9869-4764-bf24-428dbff4a4ff", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-5f66a2fc-9869-4764-bf24-428dbff4a4ff" }, { "name": "deviceInfos", "item": [ { "name": "Get Customer Device Infos (getCustomerDeviceInfos)", "id": "36bb2777-9197-4795-a699-965f91d52078", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/deviceInfos?pageSize=&page=&type=&deviceProfileId=&active=&textSearch=&sortProperty=label&sortOrder=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "deviceInfos" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'", "key": "deviceProfileId", "value": "" }, { "description": "A boolean value representing the device active flag.", "key": "active", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" } ], "variable": [ { "id": "018ec6da-163f-49c3-aad4-7e66e337d93b", "key": "customerId", "value": "", "description": "(Required) A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Returns a page of devices info objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. \n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "1be7f38c-d246-4407-ac28-7a53fa9ec19c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/:customerId/deviceInfos?pageSize=&page=&type=&deviceProfileId=&active=&textSearch=&sortProperty=label&sortOrder=DESC", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", ":customerId", "deviceInfos" ], "query": [ { "description": "(Required) Maximum amount of entities in a one page", "key": "pageSize", "value": "" }, { "description": "(Required) Sequence number of page starting from 0", "key": "page", "value": "" }, { "description": "Device type as the name of the device profile", "key": "type", "value": "" }, { "description": "A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'", "key": "deviceProfileId", "value": "" }, { "description": "A boolean value representing the device active flag.", "key": "active", "value": "" }, { "description": "The case insensitive 'substring' filter based on the device name.", "key": "textSearch", "value": "" }, { "description": "Property of entity to sort by", "key": "sortProperty", "value": "label" }, { "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)", "key": "sortOrder", "value": "DESC" } ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n },\n {\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"customerTitle\": \"\",\n \"customerIsPublic\": \"\",\n \"deviceProfileName\": \"\",\n \"active\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"PSM\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n }\n ],\n \"totalPages\": \"\",\n \"totalElements\": \"\",\n \"hasNext\": \"\"\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-1be7f38c-d246-4407-ac28-7a53fa9ec19c" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-36bb2777-9197-4795-a699-965f91d52078" } ], "id": "11115c66-3f6d-4e6e-b9fe-4b0e3e1e05b5", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-11115c66-3f6d-4e6e-b9fe-4b0e3e1e05b5" } ], "id": "c031f112-0d69-456b-af9f-d7639c294d28", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-c031f112-0d69-456b-af9f-d7639c294d28" }, { "name": "public", "item": [ { "name": "device", "item": [ { "name": "{deviceId}", "item": [ { "name": "Make Device Publicly Available (assignDeviceToPublicCustomer)", "id": "31c1e32e-c337-4ce2-a92f-1d043dbeab21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "device", ":deviceId" ], "variable": [ { "id": "3cf08553-86fd-4d84-81dc-515fca9921dc", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Device will be available for non-authorized (not logged-in) users. This is useful to create dashboards that you plan to share/embed on a publicly available website. However, users that are logged-in and belong to different tenant will not be able to access the device.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "7d50eb9b-4037-48ad-aa6c-90c94777354b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/public/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "public", "device", ":deviceId" ], "variable": [ { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-7d50eb9b-4037-48ad-aa6c-90c94777354b" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-31c1e32e-c337-4ce2-a92f-1d043dbeab21" } ], "id": "19d5b316-7ef0-49d3-ba00-411f6fe7e6b7", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-19d5b316-7ef0-49d3-ba00-411f6fe7e6b7" } ], "id": "ad0091d0-5b08-48f2-9366-56f9e7575494", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-ad0091d0-5b08-48f2-9366-56f9e7575494" } ], "id": "f528f1c7-4a18-440d-807a-33922ce9cbe5", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-f528f1c7-4a18-440d-807a-33922ce9cbe5" }, { "name": "device", "item": [ { "name": "{deviceName}", "item": [ { "name": "claim", "item": [ { "name": "Claim Device (claimDevice)", "id": "bf03133f-71b5-43e6-8c56-2cc7a992f367", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"secretKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/customer/device/:deviceName/claim", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "device", ":deviceName", "claim" ], "variable": [ { "id": "f01b995d-ed13-4481-865e-2b8e4738693f", "key": "deviceName", "value": "", "description": "(Required) Unique name of the device which is going to be claimed" } ] }, "description": "Claiming makes it possible to assign a device to the specific customer using device/server side claiming data (in the form of secret key).To make this happen you have to provide unique device name and optional claiming data (it is needed only for device-side claiming).Once device is claimed, the customer becomes its owner and customer users may access device data as well as control the device. \nIn order to enable claiming devices feature a system parameter security.claim.allowClaimingByDefault should be set to true, otherwise a server-side claimingAllowed attribute with the value true is obligatory for provisioned devices. \nSee official documentation for more details regarding claiming.\n\nAvailable for users with 'CUSTOMER_USER' authority." }, "response": [ { "id": "2ddf6b29-5f6d-459c-8398-474108b15d2a", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"secretKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/customer/device/:deviceName/claim", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "device", ":deviceName", "claim" ], "variable": [ { "key": "deviceName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-2ddf6b29-5f6d-459c-8398-474108b15d2a" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-bf03133f-71b5-43e6-8c56-2cc7a992f367" }, { "name": "Reclaim Device (reClaimDevice)", "id": "44f1bf9e-16fa-491a-adcb-8292f3143c5e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/device/:deviceName/claim", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "device", ":deviceName", "claim" ], "variable": [ { "id": "67b5e690-c263-4d6a-ba8b-0d9f8c3442d5", "key": "deviceName", "value": "", "description": "(Required) Unique name of the device which is going to be reclaimed" } ] }, "description": "Reclaiming means the device will be unassigned from the customer and the device will be available for claiming again.\n\nAvailable for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority." }, "response": [ { "id": "931e169a-6a81-4f8e-9717-11a08113d84d", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/device/:deviceName/claim", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "device", ":deviceName", "claim" ], "variable": [ { "key": "deviceName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-931e169a-6a81-4f8e-9717-11a08113d84d" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-44f1bf9e-16fa-491a-adcb-8292f3143c5e" } ], "id": "185da11d-6ad9-4351-bbb7-75e6012808da", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-185da11d-6ad9-4351-bbb7-75e6012808da" } ], "id": "e11d1600-3afe-4496-a080-edff48b56275", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-e11d1600-3afe-4496-a080-edff48b56275" }, { "name": "{deviceId}", "item": [ { "name": "Unassign Device from Customer (unassignDeviceFromCustomer)", "id": "e8e869c3-f1f8-41c6-a584-d5056a7d80a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "device", ":deviceId" ], "variable": [ { "id": "9881d4a1-20d5-4613-ac6e-3b45f670058b", "key": "deviceId", "value": "", "description": "(Required) A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "description": "Clears assignment of the device to customer. Customer will not be able to query device afterwards.\n\nAvailable for users with 'TENANT_ADMIN' authority." }, "response": [ { "id": "7e37b3bc-0978-49f6-af8e-341516e57c5e", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/customer/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "customer", "device", ":deviceId" ], "variable": [ { "key": "deviceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deviceProfileId\": {\n \"entityType\": \"DEVICE_PROFILE\",\n \"id\": \"\"\n },\n \"name\": \"\",\n \"id\": {\n \"entityType\": \"DEVICE\",\n \"id\": \"\"\n },\n \"createdTime\": \"\",\n \"tenantId\": {\n \"entityType\": \"TENANT\",\n \"id\": \"\"\n },\n \"customerId\": {\n \"entityType\": \"CUSTOMER\",\n \"id\": \"\"\n },\n \"type\": \"\",\n \"label\": \"\",\n \"firmwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"softwareId\": {\n \"entityType\": \"OTA_PACKAGE\",\n \"id\": \"\"\n },\n \"version\": \"\",\n \"additionalInfo\": {\n \"description\": \"A value representing the any type (object or primitive)\",\n \"examples\": [\n {}\n ]\n },\n \"deviceData\": {\n \"configuration\": {\n \"type\": \"\"\n },\n \"transportConfiguration\": {\n \"type\": \"\",\n \"powerMode\": \"E_DRX\",\n \"psmActivityTimer\": \"\",\n \"edrxCycle\": \"\",\n \"pagingTransmissionWindow\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-7e37b3bc-0978-49f6-af8e-341516e57c5e" } ], "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-e8e869c3-f1f8-41c6-a584-d5056a7d80a5" } ], "id": "60c53553-e018-4c88-84b6-e9c32b91d117", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-60c53553-e018-4c88-84b6-e9c32b91d117" } ], "id": "8515f46c-6d89-46b9-bc3e-de5ee0889a97", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-8515f46c-6d89-46b9-bc3e-de5ee0889a97" } ], "id": "c0229f56-7a18-477a-86ae-31e2109c6f0f", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-c0229f56-7a18-477a-86ae-31e2109c6f0f" } ], "id": "d05638f6-4b6c-48eb-8952-159df5b35b39", "createdAt": "2026-07-28T03:12:14.000Z", "updatedAt": "2026-07-28T03:12:14.000Z", "uid": "35240-d05638f6-4b6c-48eb-8952-159df5b35b39" } ], "variable": [ { "key": "baseUrl", "value": "https://demo.thingsboard.io" } ] }